Skip to content

Latest commit

 

History

History
21 lines (13 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

21 lines (13 loc) · 1.13 KB
Raw

Contributing Guidelines

Contributions to HCA working group repos are subject to overall HCA governance and technical guidance. In addition, contributors are expected to abide by the following guidelines.

  1. File structure: At the root of the project, have a directory with a meaningful title that is easy to understand and related to the topic. Inside the directory, there needs to be a working example/notebook (.ipynb) and a README.md at the root of that directory. Optional files to make your program run are welcomed but not necessary.

  2. Don't break the build: pull requests are expected to pass all automated CI checks.

  3. All Pull Request comments must be addressed, even after merge.

  4. All code must be reviewed by at least 1 other team member.

  5. All Pull Requests relating to an issue must include "connected to #123", where #123 is the issue number.

  6. Individual commit messages should clearly express the commit's purpose.

  7. To submit a vignette, follow the file structure in place, create a new branch with the user’s name followed by the vignette’s purpose (ie.{firstName}-{vignetee_topic}), and create a Pull Request.