4.7 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!
AI assisted coding
Using AI assisted coding tools for auto complete, test generation, etc is allowed so long as a human is the overall primary author of a pull request.
Contributions from supervised AI assisted coding agents who build the majority (or all of) a change, such as co pilot tasks, will be accepted only on the following basis:
- A human can verifiably prove they have reviewed and checked that the contribution does what it says it does.
- The human author provides evidence of the prompt given to the AI agent, and the logs of it producing the change. (For example - co pilot tasks produces a public log).
- The human author explicitly calls out that an supervised AI agent created the change when they make a pull request.
- The human author is prepared to own the change (just like any other change they make) and fix any issues that arise from it.
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)
