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 CONTRIBUTING.md #779

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+7 −0
Open

Update CONTRIBUTING.md #779

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
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -6,6 +6,13 @@ We welcome contributions!
- All contributions require code review. For now, our process is simple: Open a [Pull Request on GitHub](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) and ensure pylint and all tests pass on your local setup. One of the responsible code owners will then review your contribution.
- Our code coverage stands at ~93%, and we strive to increase it. Please make sure you [run coverage](https://github.com/OpenConceptLab/oclapi2#run-checks) before raising PR

## OCL License Header
- All code should start with the Open Concept Lab license header which can be found in the oclapi2 repository.

## Attribution
- Attribution is to be done within commit comments according to the the comment conventions.
- Attribution (either author or contributing authors) should not be placed into source code. When encountered, such attribution should be removed by (or with permission from) the original author(s). Contributions that require attribution (i.e., author(s) demanding attribution within the code contributions) will be graciously refused or removed from the repository.

## Dev Setup
Please follow [Dev Setup Guide](https://github.com/OpenConceptLab/oclapi2#dev-setup) and for [Running Checks](https://github.com/OpenConceptLab/oclapi2#run-checks)