Skip to content

Latest commit

 

History

History
65 lines (46 loc) · 3.11 KB

CONTRIBUTING.md

File metadata and controls

65 lines (46 loc) · 3.11 KB
Raw

Contributing to dcmqi

There are many ways to contribute to dcmqi, with varying levels of effort. Do try to look through the documentation first if something is unclear, and let us know how we can do better.

We encourage a range of Pull Requests, from patches that include passing tests and documentation, all the way down to half-baked ideas that launch discussions.

The PR Process, Continuous Integration, and Related Gotchas

How to submit a PR ?

If you are new to dcmqi development and you don't have push access to the dcmqi repository, here are the steps:

  1. Fork and clone the repository.
  2. Create a branch.
  3. Push the branch to your GitHub fork.
  4. Create a Pull Request.

This corresponds to the Fork & Pull Model mentioned in the GitHub flow guides.

If you have push access to dcmqi repository, you could simply push your branch into the main repository and create a Pull Request. This corresponds to the Shared Repository Model and will facilitate other developers to checkout your topic without having to configure a remote. It will also simplify the workflow when you are co-developing a branch.

Based on the comments posted by the reviewers of your PR, you may have to revisit your patches.

How to integrate a PR ?

Getting your contributions integrated is relatively straightforward, here is the checklist:

  • All tests pass
  • Consensus is reached. This usually means that at least one reviewer approved your contribution and a reasonable amount of time passed without anyone objecting.

Next, there are two scenarios:

  • You do NOT have push access: A dcmqi core developer will integrate your PR.
  • You have push access: Simply click on the "Merge pull request" button.

Then, click on the "Delete branch" button that appears afterward.

Automatic testing of pull requests

Every pull request is tested automatically using continuous integration using GitHub Actions each time you push a commit to it. No PR should be merged until all CI are green, unless there is a good reason to merge it first (as an example, proper testing cannot be done due to the references of the components that are changing, but must be available in the master branch).

Documentation updates

If you contribute a change that will add a new module/function to dcmqi, you are encouraged to add documentation of the new feature. We use Gitbook for maintaining dcmqi documentation.