|
| 1 | +## Contributing pull-requests (PRs) |
| 2 | + |
| 3 | +* All work is submitted via Pull Requests. |
| 4 | +* Pull Requests can be submitted as soon as there is code worth discussing. |
| 5 | + Pull Requests track the branch, so you can continue to work after the PR is submitted. |
| 6 | + Review and discussion can begin well before the work is complete, |
| 7 | + and the more discussion the better. |
| 8 | + The worst case is that the PR is closed. |
| 9 | +* Pull Requests should generally be made against master |
| 10 | +* Pull Requests should be tested, if feasible: |
| 11 | + - bugfixes should include regression tests |
| 12 | + - new behavior should at least get minimal exercise |
| 13 | +* Use a descriptive prefix for your PR: ENH, FIX, TST, DOC, STY, REF (refactor), WIP (Work in progress) |
| 14 | +* After submiting the PR, include an update to the CHANGES file: prefix: description (URL of pull request) |
| 15 | +* `make specs` |
| 16 | +* do: `make check-before-commit` before submitting the PR. This will require you to either install or be in developer mode with: `python setup.py install/develop`. |
| 17 | + |
| 18 | +## Contributing issues |
| 19 | + |
| 20 | +When opening a new Issue, please take the following steps: |
| 21 | + |
| 22 | +1. Search GitHub and/or [Neurostars](neurostars.org) for your issue to avoid duplicate reports. |
| 23 | + Keyword searches for your error messages are most helpful. |
| 24 | +2. If possible, try updating to master and reproducing your issue, |
| 25 | + because we may have already fixed it. |
| 26 | +3. OS and version |
| 27 | +4. Nipype version |
| 28 | +5. Output of: `import nipype; nipype.get_info()` |
| 29 | +6. Versions of underlying tools (e.g., ANTS, FSL, SPM, etc.,.) |
| 30 | +7. Any script, or output log, in a gist (gist.github.com) |
| 31 | +8. When applicable, and where possible, pointers to relevant data files. |
0 commit comments