b7175f7226
* Added CONTRIBUTING.md (optional) * Added backers and sponsors on the README * Added call to donate after npm install (optional) * Reusing contribute text from readme
3.8 KiB
Contribute
All contributions are welcome: bug fixes, data contributions, recommendations.
Please see the issues on GitHub before you submit a pull request or raise an issue, someone else might have beat you to it.
To contribute to this repository:
-
Download the project using git clone:
git clone git@github.com:<YOUR_USERNAME>/pokeapi.git
- Create a new branch with a descriptive name:
git checkout -b my_new_branch
-
Write some code, fix something, and add a test to prove that it works. No pull request will be accepted without tests passing, or without new tests if new features are added.
-
Commit your code and push it to GitHub
-
Open a new pull request and describe the changes you have made.
-
We'll accept your changes after review.
Simple!
Financial contributions
We also welcome financial contributions in full transparency on our open collective. Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.
Questions
If you have any questions, create an issue (protip: do a quick search first to see if someone else didn't ask the same question before!). You can also reach us at hello@pokeapi.opencollective.com.
Credits
Contributors
Thank you to all the people who have already contributed to pokeapi!
Backers
Thank you to all our backers! [Become a backer]
Sponsors
Thank you to all our sponsors! (please ask your company to also support this open source project by becoming a sponsor)
