User Tools
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
cppdev:submitpatches [2017-02-05 13:22] Carsten Remove obsolete legal stuff (copyright transfer / assignment) |
cppdev:submitpatches [2017-02-05 13:37] (current) Carsten Remove more obsolete text |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== How to Submit Patches ====== | ====== How to Submit Patches ====== | ||
| - | Cafu is to a large degree a community project, and we need and very much appreciate your help. | + | Cafu is to a community project and we need and very much appreciate your help. |
| Your contributions and especially patches are very important for Cafu. | Your contributions and especially patches are very important for Cafu. | ||
| Patches help us to add new features, improve code quality and fix bugs, so we are happy and grateful if you contribute them. :-D | Patches help us to add new features, improve code quality and fix bugs, so we are happy and grateful if you contribute them. :-D | ||
| - | |||
| - | Remember that if you have any questions about the steps here, you can always post them at the [[http://forum.cafu.de|Cafu forum]] and we'll do our best to help you. | ||
| Line 16: | Line 14: | ||
| Therefore, please provide any required documentation such as source code comments (preferably in familiar and simple [[http://www.doxygen.org|Doxygen]] format), high-level overviews, diagrams, etc. Without documentation, another developer would have to write it, and the patch cannot be applied until he has time to do it. | Therefore, please provide any required documentation such as source code comments (preferably in familiar and simple [[http://www.doxygen.org|Doxygen]] format), high-level overviews, diagrams, etc. Without documentation, another developer would have to write it, and the patch cannot be applied until he has time to do it. | ||
| - | |||
| - | |||
| - | ===== Mechanics of Patch Submission ===== | ||
| === Make atomic patches === | === Make atomic patches === | ||
| Line 28: | Line 23: | ||
| On the other hand, do not split a single code change into multiple patches: | On the other hand, do not split a single code change into multiple patches: | ||
| Two patches, one of them being "implementation of new member-functions", the other "changes in class documentation to accommodate new members" are two bad patches. They are related to one, logically indivisible thing, so they should be in one common patch. | Two patches, one of them being "implementation of new member-functions", the other "changes in class documentation to accommodate new members" are two bad patches. They are related to one, logically indivisible thing, so they should be in one common patch. | ||
| - | |||
| - | |||
| - | ===== Submitting the Patch ===== | ||
| - | |||
| - | === Describe your changes === | ||
| - | |||
| - | Remember that it is often not easy to understand the purpose of your patch just from its source code. If you provide detailed description of the patch, we will be able to apply it much faster -- and we will love you for submitting such nice patches! :-D | ||
| ===== Final Considerations ===== | ===== Final Considerations ===== | ||
| - | - We need "Fork me on Bitbucket" | + | - On Dive-In, we need "How to contribute" / "Fork me on Bitbucket". |
| - Why Your Project Doesn't Need a Contributor Licensing Agreement, http://ebb.org/bkuhn/blog/2014/06/09/do-not-need-cla.html | - Why Your Project Doesn't Need a Contributor Licensing Agreement, http://ebb.org/bkuhn/blog/2014/06/09/do-not-need-cla.html | ||
| - https://kernel.org/doc/html/latest/process/submitting-patches.html | - https://kernel.org/doc/html/latest/process/submitting-patches.html | ||
cppdev/submitpatches.txt ยท Last modified: 2017-02-05 13:37 by Carsten