Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
28 lines (20 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

28 lines (20 loc) · 1.93 KB

Contributing to OCLAPI2

We welcome contributions!

Code Review & Acceptance Process

  • All contributions require code review. For now, our process is simple: Open a Pull Request on GitHub 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 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 and for Running Checks

Dev Setup with KeyCloak (SSO)

Please follow Dev Setup with KeyCloak Guide

Getting Started as a contributor:

1. Create an Account on [OCL Online](https://app.openconceptlab.org)
2. Introduce yourself on [OCL Chat](https://chat.openconceptlab.org)
3. Setup your local dev env
4. Pickup an ["intro" tag ticket](https://github.com/OpenConceptLab/ocl_issues/issues?q=is%3Aopen+is%3Aissue+label%3Aintro) and raise PR
5. Participate in [OCL Dev](https://openconceptlab.org/ocl-dev-community/) call