-
Notifications
You must be signed in to change notification settings - Fork 5
Standards for open source contributions
rvinaybharadwaj edited this page Jan 11, 2022
·
1 revision
Issue a pull request if you have new features (agents, envs, workflows, etc.) to add to EXARL.
- The code must be fully documented (Numpy docstring style: https://numpydoc.readthedocs.io/en/latest/format.html)
- We encourage you to check if sphinx is able to build documentation using the docstrings
- Make sure the code is compliant with the EXARL style (Must pass style checks. Refer to https://github.com/exalearn/EXARL/blob/develop/.flake8)
- Unit tests must be included in the pull request to test added features
- Run the feature with available environments/agents/workflows in EXARL
- If no applicable environment, please provide a simple one or point to an appropriate repository