Contributing

PhilanthroPy takes outside contributions. Docs fixes, missing tests, and clearer error messages are as welcome as new estimators; a first PR does not need to be big.

Start here

Pick a good first issue. Each one names the exact files to touch, the steps to follow, and the single command that proves the work is done. Comment on the issue to claim it.

Nothing there that suits you? Open an issue describing what you want to change before writing the code, so nobody spends an evening on something that would be turned down.

The workflow

Fork, branch, run make ci, push to your fork, open a pull request against main. The full setup (including the local gate and the four extra checks CI runs on top of it) is in CONTRIBUTING.md.

Setup plus a first green make ci takes about eight minutes.

Everyone who has landed a change is credited in CONTRIBUTORS.md add yourself in the same pull request.

Questions

Ask in Discussions, or on the issue you are working on. Asking is a valid contribution; if something in the guide does not work, that is a bug in the guide.

By participating you agree to abide by the Code of Conduct.