Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update contributor guide to include language from the template #268

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update contributor guide to include language from the template #268

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
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 [[email protected]](mailto:[email protected]).