We welcome:
- Bug reports
- Pull requests for bug fixes
- Documentation improvements
We have a bug bounty of sorts for PRs, outlined in the readme
If you're thinking about creating submitting a new environment, please contact us first. There's a very small number of things that we'd like to add in the main PettingZoo repo that we haven't already done.
Contributing code is done through standard github methods:
- Fork this repo
- Commit your code
- Submit a pull request. It will be reviewed by maintainers and they'll give feedback or make requests as applicable
- Make sure existing tests pass (run
pytest pettingzoo/tests/pytest_runner.py) - Make sure linter passes (run
check_style.sh) - Make sure your new code is properly tested and fully-covered
- Any fixes to environments should include fixes to the appropriate documentation
- Changes to environment functionality should be avoided when reasonable, and when they occur the environment version must be bumped.