Difference between revisions of "How to contribute"
Jump to navigation
Jump to search
(Replaced content with "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...") Tag: Replaced |
|||
Line 1: | Line 1: | ||
+ | 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_contribution|Sign off your contribution]] (this is a Git feature) | |
+ | * Follow [https://chris.beams.io/posts/git-commit/ 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 [https://github.com/MITK/MITK/compare GitHub pull requests] for your contribution. :-) | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− |
Revision as of 12:37, 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. :-)