Thank you for your interest in trying to predict Pokemon types! We hope you have as much fun as we're having trying to determine a Pokemon's type. Any contributions made will be recorded in this document and updated as we go.
Please read our Code of Conduct to keep the data science region approachable and respectable. Don't be a Shamus trainer! (From the show, see here)
In this guide, you will get an overview of how to contribute to the project. From opening an issue, creating a PR, reviewing, and merging the PR, we'll get you to be the best contributor like no one ever was!
You can use the table of contents icon in the top left corner to jump around this document quickly.
To get an overview of the project, read the README. To contribute with our project, here are some resources to help you get started with open source contributions:
You can contribute to our project in many way! Here are just a few examples of things we're looking for:
- Issues: if there are any problems with our code or documents, we want to know about it! Open an issue and we'll get right on it.
- Forking: the best way to make suggestions to our code!
If you spot a problem with any of our documents, search if that issue already exists. If a related issue doesn't exist, you can always open a new issue.
Before forking and opening a PR, make sure to create issue and have one of the administrators agree that it is an issue. We don't want you to waste any of your time!
Look through existing issues and if any interest you, feel free to open a PR with a fix for our code/documents. You can use the labels as filters to search for things you're passionate about.
Follow the contributing to a project guidelines to open your own fork of the project and commit your changes. Then, open your pull request and wait for one of the gym leaders (administrators) to review it and hopefully we can incorporate your changes! Don't forget to self-review your update to speed up the review process.
We follow the PEP8 style guide so please ensure code is tidy and easy to read as such.
Gym Members are part of the core team who will follow the proper branching and git ettiquette when submitting a pull request. These members can contribute to adding new features and discussions on the direction of the project. Gym members are able to review and accept pull requests.
If you are looking to contribute to this project, this is likely where you fit in! Start training by reviewing the proper documentation and finding issues that we need help with.
Make sure you fill in the proper documentation to help our team understand the changes and the purpose of the PR. Also, if you are solving a known issue, please link the PR to the issue! Note: Gym members may ask questions, request additional information or suggest changes before the PR can be merged. Not just any trainer can get a gym badge!
After these steps, your PR will be merged! On behalf of Pokemon trainers everywhere, we thank you for your contribution.
- Caroline Tang (Gym Leader)
- Sarah Abdelazim (Gym Leader)
- Vincent Ho (Gym Leader)
- Wilfred Hass (Gym Leader)