diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index e5a3f1f317..e1d84d5604 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,23 +1,82 @@ -## Stop! Before you create this issue (you can delete this section when opening the issue): -1. Have you validated that your config.json is valid JSON? Use http://jsonlint.com/ to check. -2. Have you searched to see if there are other issues for the same issue? If so, comment on that issue instead. -3. Are you running `master`? We work on the `dev` branch and then add that functionality to `master`. Your issue may be fixed on `dev` and there is no need for this issue, just wait and it will eventually be merged to `master`. + ### Expected Behavior + ### Actual Behavior + + + +### Your FULL config.json (remove your username, password, gmapkey and any other private info) + -### Your config.json (remove your credentials and any other private info) -``` -your config here -``` +### Output when issue occurred + + ### Steps to Reproduce + ### Other Information -OS: -Git Commit: (run 'git log -n 1 --pretty=format:"%H"' and paste it here) -Python Version: (run 'python -V' and paste it here) +OS: + +Branch: + +Git Commit: + +Python Version: + +Any other relevant files/configs (eg: path files) + + + + + + + + + + + +### Short Description + + + +### Possible solution + + + +### How it would help others + + + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a43df95477..2b809c3620 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,15 +1,14 @@ -# Please Note (you may remove this section before opening your PR): +# Please Note - You may remove this section before opening your PR We receive lots of PRs and it is hard to give proper review to PRs. Please make it easy on us by following these guidelines: 1. We do not accept changes to `master`. Please make sure your pull request is aimed at `dev`. 2. If you changed a bunch of files (that aren't config files) or multiple workers to implement your feature, it probably won't get proper attention. Please split it up into multiple, smaller, more focused, and iterative PRs if you can. 3. If you are adding a config value to something, make sure you update the appropriate `config.json` example files. - +4. If your pull request is fixing / resolving / or closing any of the issues, please ensure the [correct syntax](https://github.com/blog/1506-closing-issues-via-pull-requests) is used eg: Closes #X, Fixes#Y ## Short Description: -## Fixes (provide links to github issues if you can): +## Fixes/Resolves/Closes (please use correct syntax): - - - - diff --git a/README.md b/README.md index bc81fa9858..408d4567b7 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,25 @@ # PokemonGo-Bot PokemonGo bot is a project created by the [PokemonGoF](https://github.com/PokemonGoF) team. -The project is currently setup in two main branches. `dev` also known as `beta` and `master` also known as `stable`. Make sure to submit your PR's to `dev`. +The project is currently setup in two main branches. +- `dev` also known as `beta` - This is where the latest features are, but you may also experience some issues with stability/crashes +- `master` also known as `stable` - The bot 'should' be stable on this branch, and is generally well tested ## Support -Configuration issues/help - If you need any help please don't create an issue as we have a great community on Slack. You can count on the community in #help channel. +###Configuration issues/help +If you need any help please don't create an issue as we have a great community on Slack. You can count on the community in [#help](https://pokemongo-bot.slack.com/messages/help/) channel. - [Click here to signup (first time only)](https://pokemongo-bot.herokuapp.com) - [Join if you're already a member](https://pokemongo-bot.slack.com/messages/general/). -[Bugs / Issues](https://github.com/PokemonGoF/PokemonGo-Bot/issues?q=is%3Aissue+sort%3Aupdated-desc) - If you discover a bug in the bot, please [search our issue tracker first](https://github.com/PokemonGoF/PokemonGo-Bot/issues?q=is%3Aissue+sort%3Aupdated-desc). If it hasn't been reported, please [create a new issue](https://github.com/PokemonGoF/PokemonGo-Bot/issues/new) and ensure you follow the template so that our team can assist you as quickly as possible +###[Bugs / Issues](https://github.com/PokemonGoF/PokemonGo-Bot/issues?q=is%3Aissue+sort%3Aupdated-desc) +If you discover a bug in the bot, please [search our issue tracker](https://github.com/PokemonGoF/PokemonGo-Bot/issues?q=is%3Aissue+sort%3Aupdated-desc) first. If it hasn't been reported, please [create a new issue](https://github.com/PokemonGoF/PokemonGo-Bot/issues/new) and ensure you follow the template guide so that our team can assist you as quickly as possible. -[Feature Requests](http://feathub.com/PokemonGoF/PokemonGo-Bot) - If you have a great idea to improve the bot don't create an issue, use our [feature hub](http://feathub.com/PokemonGoF/PokemonGo-Bot). While you're there vote on other features to let the devs know what is most important to you +###[Feature Requests](https://github.com/PokemonGoF/PokemonGo-Bot/labels/Feature%20Request) +If you have a great idea to improve the bot, please [search our feature tracker](https://github.com/PokemonGoF/PokemonGo-Bot/labels/Feature%20Request) first to ensure someone else hasn't already come up with the same great idea. If it hasn't been requested, please [create a new request](https://github.com/PokemonGoF/PokemonGo-Bot/issues/new) and ensure you follow the template guide so that it doesnt get lost with the bug reports. +While you're there vote on other feature requests to let the devs know what is most important to you. + +###[Pull Requests](https://github.com/PokemonGoF/PokemonGo-Bot/pulls) +If you'd like to make your own changes, make sure you follow the pull request template, and ensure your PR is made against the 'dev' branch ## Table of Contents - [Installation](https://github.com/PokemonGoF/PokemonGo-Bot/blob/dev/docs/installation.md)