First off, thanks for taking the time to contribute! 🎉
Help us keep this project open and inclusive. Please read and follow our Code of Conduct.
Report bugs using Github's issues
We use GitHub issues to track public bugs. Report a bug by opening a new issue.
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can.
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
- If you know who should look into this, then assign the issue. If you don't, just assign it to @robinhenry.
Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:
- Fork the repo and create your branch from
master. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Request @robinhenry as the reviewer.
- Issue that pull request!
If you designed a new gym-anm environment and would like it to be added to the project, you can do so as follows:
- On your own fork of the repository, create a new folder in gym_anm/envs/ and name it after the environment you designed.
- Make sure all your code files are contained within that repository.
- Write a documentation page for your environment in docs/source/topics/ and add it to the documenation index docs/source/index.rst.
- Register your environment with
Gymin gym_anm/__init__.py. - Propose your environment to be added to the codebase using a Pull Request (see above).
Please follow the same coding conventions as used in the existing codebase.