From 1aa2458db4ae252da84fc6e7e315b28d3b7ee82e Mon Sep 17 00:00:00 2001 From: langerhans Date: Sat, 23 Jul 2016 18:56:09 +0200 Subject: [PATCH] Add contribution guidelines, issue template and PR template --- .github/CONTRIBUTING.md | 18 ++++++++++++++++++ .github/ISSUE_TEMPLATE.md | 19 +++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 13 +++++++++++++ 3 files changed, 50 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..33fc433c --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -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/). \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..2496eccf --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -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] \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..57ef51de --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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... \ No newline at end of file