Difference between revisions of "How to contribute"
Jump to navigation
Jump to search
| Line 9: | Line 9: | ||
* If you touch code in header files or write documentation, build the doc target to check for any warnings | * If you touch code in header files or write documentation, build the doc target to check for any warnings | ||
| − | That said, please use [https://github.com/MITK/MITK/compare GitHub pull requests] for your contribution. It would be also great if you could [https://phabricator.mitk.org/maniphest/task/edit/form/1/ open a ticket in our ticket system]. Leave the priority set at | + | That said, please use [https://github.com/MITK/MITK/compare GitHub pull requests] for your contribution. It would be also great if you could [https://phabricator.mitk.org/maniphest/task/edit/form/1/ open a ticket in our ticket system]. Leave the priority set at ''Needs Triage'' and add the ''#pull_request'' tag. This is the best way of raising awareness. |
Latest revision as of 12:43, 11 February 2021
First of all, we are happy about every piece of code/documentation that you contribute. Communication is key. Please coordinate your contributions ahead of time with us to minimize overhead work for both sides.
We also kindly ask to follow a few rules & guidelines:
- Sign off your contribution (this is a Git feature)
- Follow the seven rules of a great Git commit message
- Split your work in easy to digest and coherent commits
- Keep reformatting of existing code to a minimum or do it in a separate commit
- If you touch code in header files or write documentation, build the doc target to check for any warnings
That said, please use GitHub pull requests for your contribution. It would be also great if you could open a ticket in our ticket system. Leave the priority set at Needs Triage and add the #pull_request tag. This is the best way of raising awareness.