Thank you for your interest in contributing to the ML-Agents toolkit! We are incredibly excited to see how members of our community will use and extend the ML-Agents toolkit. To facilitate your contributions, we've outlined a brief set of guidelines to ensure that your extensions can be easily integrated.
First, please read through our code of conduct, as we expect all our contributors to follow it.
Second, before starting on a project that you intend to contribute to the ML-Agents toolkit (whether environments or modifications to the codebase), we strongly recommend posting on our Issues page and briefly outlining the changes you plan to make. This will enable us to provide some context that may be helpful for you. This could range from advice and feedback on how to optimally perform your changes or reasons for not doing it.
Lastly, if you're looking for input on what to contribute, feel free to
reach out to us directly at [email protected] and/or browse the GitHub
issues with the contributions welcome label.
Starting with v0.3, we adopted the
Gitflow Workflow.
Consequently, the master branch corresponds to the latest release of
the project, while the develop branch corresponds to the most recent, stable,
version of the project.
Thus, when adding to the project, please branch off develop
and make sure that your Pull Request (PR) contains the following:
- Detailed description of the changes performed
- Corresponding changes to documentation, unit tests and sample environments (if applicable)
- Summary of the tests performed to validate your changes
- Issue numbers that the PR resolves (if any)
We are also actively open to adding community contributed environments as examples, as long as they are small, simple, demonstrate a unique feature of the platform, and provide a unique non-trivial challenge to modern machine learning algorithms. Feel free to submit these environments with a PR explaining the nature of the environment and task.
We run CircleCI on all PRs; all tests must be passing before the PR is merged.
Several static checks are run on the codebase using the pre-commit framework during CI. To execute the same checks locally, install pre-commit and run pre-commit run --all-files. Some hooks (for example, black) will output the corrected version of the code; others (like mypy) may require more effort to fix.
All python code should be formatted with black. Style and formatting for C# may be enforced later.
We use mypy to perform static type checking on python code. Currently not all code is annotated but we will increase coverage over time. If you are adding or refactoring code, please
- Add type annotations to the new or refactored code.
- Make sure that code calling or called by the modified code also has type annotations.
The type hint cheat sheet provides a good introduction to adding type hints.
When you open a pull request, you will be asked to acknolwedge our Contributor License Agreement. We allow both individual contributions and contributions made on behalf of companies. We use an open source tool called CLA assistant. If you have any questions on our CLA, please submit an issue or email us at [email protected].