From d0c6dbfb42a95cfe3259eb8cbbc7085e3b6cab11 Mon Sep 17 00:00:00 2001 From: Brian Warner Date: Tue, 22 Nov 2022 08:32:27 -0500 Subject: [PATCH] Update contributor guide to include language from the template Signed-off-by: Brian Warner --- CONTRIBUTING.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4919ad54..dbd15e96 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,26 @@ # Contributing + +Thank you for contributing to Spock! This guide will help you get started and know what to expect. All contributions and project spaces are subject to our [Code of Conduct](https://github.com/fidelity/.github/blob/main/CODE_OF_CONDUCT.md). + We welcome all contributions from the community! Any contributions to `spock` should come through valid Pull/Merge Requests in the public repository. +Please open an issue **unless** you are making a significant security disclosure. + +## How to disclose security concerns responsibly + +Please follow the instructions in our [security policy](https://github.com/fidelity/.github/blob/main/SECURITY.md) (also visible in the Security tab on the project's repo). + ## Contribution Guidelines 1. Adhere to [PEP-8](https://www.python.org/dev/peps/pep-0008/) standards. 2. Run black and isort linters before creating a PR. 3. Any changes to core functionality must pass all existing unit tests. 4. Additional functionality should have associated unit tests. -5. Provide documentation ([Google Docstring format](https://google.github.io/styleguide/pyguide.html)) whenever possible, even for simple functions or classes. \ No newline at end of file +5. Provide documentation ([Google Docstring format](https://google.github.io/styleguide/pyguide.html)) whenever possible, even for simple functions or classes. +6. Your contribution must be received under the project's open source license. +7. 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](https://developercertificate.org/). + + +## Getting help + +If you have other questions about this project, please open an issue. To reach the Fidelity OSPO directly, please email [opensource@fmr.com](mailto:opensource@fmr.com).