Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
21 lines (17 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

21 lines (17 loc) · 1.01 KB

Please follow the steps in the guidelines below (you can find an example following the guidelines). If in doubt, ask Dzhoshkun Shakir (d.shakir@ucl.ac.uk).

Guidelines

  1. Create a new issue.
  2. Branch off dev for the new issue.
  3. Define your tests (usually in the NiftyMatch-Test repository).
  4. Do your coding.
  5. TEST YOUR IMPLEMENTATION.
  6. MAKE SURE CONTINUOUS INTEGRATION BUILDS OF YOUR BRANCH ARE OK.
  7. Submit a pull request from the new branch to dev.

Example

  1. When you add a new issue numbered 19 and entitled Add support for interpolation,
  2. branch off dev to a new branch called 19-add-support-for-interpolation.
  3. Think about how you will test the interpolation method you'll implement. If needed, add automated tests into NiftyMatch-Test.
  4. Implement the interpolation method.
  5. TEST YOUR IMPLEMENTATION.
  6. MAKE SURE CONTINUOUS INTEGRATION BUILDS OF 19-add-support-for-interpolation ARE OK.
  7. Submit a pull request from 19-add-support-for-interpolation to dev.