Thank you for contributing to Stoke! This guide will help you get started and know what to expect. All contributions and project spaces are subject to our Code of Conduct.
We welcome all contributions from the community! Any contributions to stoke should come through valid Pull Requests
in the public open-source repository.
Please open an issue unless you are making a significant security disclosure.
Please follow the instructions in our security policy (also visible in the Security tab on the project's repo).
- Adhere to PEP-8 standards.
- Run black and isort linters before creating a PR.
- Any changes to core functionality must pass all existing unit tests.
- Additional functionality should have associated unit tests.
- Provide documentation (Numpy Docstring format) whenever possible, even for simple functions or classes.
- Your contribution must be received under the project's open source license.
- You must have permission to make the contribution. We strongly recommend including a Signed-off-by line to indicate your adherence to the Developer Certificate of Origin.
If you have other questions about this project, please open an issue. To reach the Fidelity OSPO directly, please email opensource@fmr.com.