Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added contrubution.md and other files #12

Merged
merged 2 commits into from
Oct 5, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
**Commits**
* Follow the template of while creating issues and before making a PR.
* Write clear meaningful git commit messages (Do read http://chris.beams.io/posts/git-commit/)
* Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (More info at https://github.com/blog/1506-closing-issues-via-pull-requests )
* When you make very very minor changes to a PR of yours (like for example fixing a failing travis build or some small style corrections or minor changes requested by reviewers) make sure you squash your commits afterwards so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at https://davidwalsh.name/squash-commits-git )
* When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker.
* Collective Code Construction Contract (https://rfc.zeromq.org/spec:42/C4/)

**Feature Requests and Bug Reports**
* When you file a feature request or when you are submitting a bug report to the [issue trackerhttps://github.com/Bashmug/HappyPanda/issues), make sure you add steps to reproduce it. Especially if that bug is some weird/rare one.

**Join the development**
* Before you join development, please set up the system on your local machine and go through the application completely. Press on any link/button you can find and see where it leads to. Explore. (Don't worry ... Nothing will happen to the app or to you due to the exploring :wink: Only thing that will happen is, you'll be more familiar with what is where and might even get some cool ideas on how to improve various aspects of the app.)
* If you would like to work on an issue, drop in a comment at the issue. If it is already assigned to someone, but there is no sign of any work being done, please free to drop in a comment so that the issue can be assigned to you if the previous assignee has dropped it entirely.

**Review Policy**

Pull requests must be reviewed before merge. The goal is to have two people review the pull request. With this we want to spread the knowledge about the project and encourage positive feedback.

- A pull-request with **two** positive reviews of contributors should be merged by the last reviewer and can be merged by anyone with write access.
- A pull-request with **one** positive review of contributors can be merged after 24 hours by anyone with write access.
- A pull-request with **no** positive review can be merged after three days by anyone with write access.

Note that this does not clarify what to do if there a negative reviews.
The goal is again to spread knowledge and feedback but also prevent frustration and stagnation of the project.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
**I'm submitting a ...** (check one with "x")
- [ ] bug report
- [ ] feature request
- [ ] support request => Please do not submit support requests here, instead ask your query in out Gitter channel ahttps://gitter.im/BashMug/HappyPanda

**Actual Behaviour**

<!-- Describe how the bug manifests. -->

**Expected Behaviour**

<!-- State here what the feature should enable the user to do. -->

**Steps to reproduce it**

<!-- Add steps to reproduce bugs or add information on the place where the feature should be implemented. Add links to a sample deployment or code. -->

**Related code:**

```
insert any relevant code here else remove this section
```

**Other information:**
<!-- List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to fix, Stack Overflow links, forum links, etc. -->

****Would you like to work on the issue?**

<!-- Let us know if this issue should be assigned to you or tell us who you think could help to solve this issue. -->
25 changes: 25 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!--
(Thanks for sending a pull request! Please make sure you click the link above to view the contribution guidelines, then fill out the blanks below.)
-->

#### Checklist

- [ ] There is a corresponding issue for this pull request.
- [ ] My branch is up-to-date with the Upstream `master` branch.
- [ ] The unit tests pass locally with my changes (provide a screenshot or link for test) <!-- use `nosetests tests/unittests` to run all the tests -->
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have added necessary documentation (if appropriate)

#### Short description of what this resolves:


#### Changes proposed in this pull request:

-
-
-

<!-- Add the issue number that is fixed by this PR (In the form Fixes #123) -->

Fixes #

5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
# HappyPanda
A game opposite to Blue Whale

[![Gitter](https://badges.gitter.im/BashMug/HappyPanda.svg)](https://gitter.im/BashMug/HappyPanda?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

A game opposite to Blue Whale