Skip to content

Commit

Permalink
Merge pull request Grover-c13#161 from langerhans/lh/contributing
Browse files Browse the repository at this point in the history
Add contribution guidelines, issue template and PR template
  • Loading branch information
Grover-c13 authored Jul 23, 2016
2 parents c1df2e1 + 1aa2458 commit 26abd97
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Contributing
Thank you for wanting to help with this project! Pull requests and bug reports are always welcome, there are just some small things you should review before submitting.

## Issues
If you find any issue with the library, feel free to open an issue report. If it's just a small issue you might want to consider just asking on Slack (see below).

## Feature Requests
You may open an issue also to request new features. Make sure you describe what you are missing in the library and add any pointers someone might need to implement it.

## Pull Requests
If you consider submitting a pull request, please note the following:

1. All pull requests **must** be submitted to the `Development` branch. The `master` branch is exclusively mutable by release. PRs against `master` will not be merged.
2. Pleae make sure you follow the projects code style. To make sure you did, you can use `./gradlew checkstyleMain`.
3. The project is licensed under [GNU GPLv3](../LICENSE.txt) thus all code you submit will be subject to this license.

## Contact
If you have any questions regarding the library you can ask those on the `#javaapi` channel on the [Pokemon GO Reverse Engineering Slack](https://pkre.slack.com/). You can [get your invite here](https://shielded-earth-81203.herokuapp.com/).
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
**Description:**
[Short description of the issue observed. If this ia feature request you can modify the template as required.]

**Steps to reproduce:**

1. [Step 1]
2. [Step 2]

**Expected behavior:**
[What should happen?]

**Actual behavior:**
[What actually happens]

**Stacktrace (If it's a crash):**
[Please use pastebin if it's too long]

**Version:**
[The version of the lib you used]
13 changes: 13 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
### Prerequisites (Remove this section if you want)
Make sure you...

* Follow the [contribution guidelines](CONTRIBUTING.md)
* Follow the code style (run `./gradlew checkstyleMain`)
* Submit this PR against the `Development` branch.

**Fixed issue:** [Reference the issue number here, or remove if not a fix]

**Changes made:**

* List your changes here
* Change 2...

0 comments on commit 26abd97

Please sign in to comment.