User Tools
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
cppdev:submitpatches [2010-01-18 19:02] Carsten Added section "Copyright Considerations" |
cppdev:submitpatches [2017-02-05 13:14] Carsten Remove a first bunch of nonsense that is obsolete with Git pull requests |
||
|---|---|---|---|
| Line 3: | Line 3: | ||
| Cafu is to a large degree a community project, and we need and very much appreciate your help. | Cafu is to a large degree 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 (how could we dislike your help, after all?). :-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 |
| - | However, we have all sort of problems with applying non-standard patches. | + | 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. |
| - | To make life easier for both you and us, please follow the few simple rules below when submitting patches. | + | |
| - | + | ||
| - | Remember that if you have any questions about the steps here, you can always post them to the [[http://www.cafu.de/forum/|Cafu forum]] and we'll do our best to help you. | + | |
| ===== Changing Cafu ===== | ===== Changing Cafu ===== | ||
| - | === Follow the rules === | + | Please read the [[cppdev:codingconventions]] and try to conform to them. In particular, please respect the indentation rules (4 spaces, no TABs) -- patches are really difficult to read otherwise. |
| - | Read the [[cppdev:codingconventions]] and try to conform to them. In particular, please respect the indentation rules (4 spaces, no TABs) -- patches are really difficult to read otherwise. | + | |
| === Provide documentation === | === Provide documentation === | ||
| Line 23: | Line 19: | ||
| ===== Mechanics of Patch Submission ===== | ===== Mechanics of Patch Submission ===== | ||
| - | |||
| - | === Use the latest version === | ||
| - | Always make your patches against the latest version of Cafu. | ||
| - | |||
| - | In most of the cases, you should make a patch against the head revision of the SVN trunk. You can learn how to download the source code from the Subversion repository [[cppdev:gettingstarted|here]]. | ||
| - | |||
| - | If you cannot access the Subversion repository (for example when you are behind a firewall), make the patch against the latest source code release at the [[http://www.cafu.de/downloads|Downloads]] page. | ||
| - | |||
| - | === Standard patch format === | ||
| - | A patch is a single file that contains the differences in all files that you modified. Patch files are small, easy to read and understand and can be applied with a single command, even if the affected files have been changed since the moment when the patch was created. | ||
| - | |||
| - | Therefore, do **not** send us ZIP archives, whole files, code snippets or other arbitrary text that we'd spend hours trying to understand. | ||
| - | |||
| - | There are several ways to create patches: | ||
| - | * [[http://tortoisesvn.net/|{{ http://tortoisesvn.tigris.org/tortoisesvn_logo_hor468x64.PNG}}]] Use [[http://tortoisesvn.net/|TortoiseSVN]] or a similar GUI client for Subversion. TortoiseSVN integrates into the Windows explorer and can create patches comfortably from the right-click context menu. It also allows you to select the individual files that should or shouldn't be included in the patch. Thus we recommend that you use TortoiseSVN, especially if you don't feel comfortable with ''svn diff'' at the command-line. | ||
| - | * Also straightforward and easy is the use of ''svn diff'' at the command-line: <code>svn diff > mypatch.patch</code> Similar to TortoiseSVN, if your patch adds or removes files, you should run ''svn add'' or ''svn remove'' before ''svn diff''. | ||
| - | * If you don't use Subversion at all, you can use the ''diff'' program which is a standard part of most Unix systems and is available as part of the Cygwin package or elsewhere for Windows: <code>diff -uNr Cafu-src-orig Cafu-src-mine > mypatch.patch</code> Use the ''-u'' option for unified diff output and ''-N'' for the new files to be included in the patch. | ||
| - | |||
| - | === Standard patch file extensions === | ||
| - | Use standard extension ''.diff'' or ''.patch'' for the patch file. | ||
| - | |||
| - | === Omit auto-generated files === | ||
| - | Don't include auto-generated files (log files, temporary scripts, etc.) in the patch. | ||
| - | |||
| - | The simplest way to handle this is to use TortoiseSVN, which allows you to select which files should and which files shouldn't be included in the patch. Alternatively, it is also easy to edit the patch to remove appropriate chunks. | ||
| === Make atomic patches === | === Make atomic patches === | ||
| - | Do not split single code change into multiple patches. A patch should be self-contained -- //one patch for one thing//. | + | A patch should be self-contained -- //one patch for one thing//. |
| - | A patch that adds bitmaps to menu items and fixes a bug in the network code is a bad patch. It should be splitted into two patches. On the other hand, two patches, one of them being "implementation of new member-functions", the other "changes in class description to accommodate new members" are two bad patches. They are related to one, logically indivisible, thing, so they should be part of one patch. | + | Do not combine multiple new features in a single patch: |
| + | A patch that adds bitmaps to menu items and fixes a bug in the network code is a bad patch. It should be splitted into two patches. | ||
| - | Another example: if you adapted the build system to work on new, previously unsupported platform, we would gladly accept your patch. Just send us single patch, not 10 patches, one for each modified file. | + | 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. | ||
| ===== Submitting the Patch ===== | ===== Submitting the Patch ===== | ||
| - | |||
| - | === Use Trac === | ||
| - | Please do **not** send the patches to the forum, mailing list, or to any developer's personal email address. Instead, use the [[http://trac.cafu.de|issue tracker]]. Then you will be notified about the progress the patch makes, e.g. when the patch is accepted or if there is a problem with applying the patch. | ||
| === Describe your changes === | === Describe your changes === | ||
| - | Please fill in the ticket form as explained at [[cppdev:SubmitTickets]]. | ||
| 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 | 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 | ||
| - | |||
| - | === Let us know your name === | ||
| - | We'd also like to give you credit for your patch (unless it's something really trivial as we avoid mentioning very small changes in our changelog) but we need to know your real name for this. Please tell us if we don't know you already e.g. from the forum. | ||
| ===== Copyright Considerations ===== | ===== Copyright Considerations ===== | ||
| + | |||
| + | This section will be removed soon. See: | ||
| + | |||
| + | - 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 | ||
| + | |||
| + | ---- | ||
| From a strictly legal point of view, when you submit a patch or another contribution, you are the /*exclusive*/ copyright holder of your contribution, and CFS is the /*exclusive*/ copyright holder of Cafu. | From a strictly legal point of view, when you submit a patch or another contribution, you are the /*exclusive*/ copyright holder of your contribution, and CFS is the /*exclusive*/ copyright holder of Cafu. | ||
| Line 84: | Line 57: | ||
| /* ((These actions require the exclusive copyright of Cafu. In other words: Nobody except CFS can ever legally distribute Cafu under a license other than GPL -- an important feature that we need to fight possible GPL violations and thus the spirit of free software.)) */ | /* ((These actions require the exclusive copyright of Cafu. In other words: Nobody except CFS can ever legally distribute Cafu under a license other than GPL -- an important feature that we need to fight possible GPL violations and thus the spirit of free software.)) */ | ||
| - | <HTML><p style="border: 1px solid red; padding: 0.5em;">Therefore, when you contribute source code to Cafu, we ask you to assign or extend the copyright of your contribution to CFS, or to disclaim your copyright by putting your contribution into the public domain.</p></HTML> | + | <HTML><p style="border: 1px solid red; padding: 0.5em;">Therefore, when you contribute source code to Cafu, we ask you to assign the copyright of your contribution to <acronym title="Carsten Fuchs Software">CFS</acronym>, or – if that is not possible under your national law – to disclaim all interest in your copyright and grant <acronym title="Carsten Fuchs Software">CFS</acronym> the right to use your contribution in the Cafu Engine as outlined above.</p></HTML> |
| Here is the single most pressing question that we assume occurs to most people now: | Here is the single most pressing question that we assume occurs to most people now: | ||
| Line 94: | Line 67: | ||
| * The authorship and all credits remain with you. Your contributions will clearly carry your name and everything gets properly documented in our changelog (unless you tell us otherwise). | * The authorship and all credits remain with you. Your contributions will clearly carry your name and everything gets properly documented in our changelog (unless you tell us otherwise). | ||
| + | |||
| + | * Once your code has been integrated into Cafu, we assume maintenance for it as for everything else. That means that we make sure that the code will still work after future changes, in future releases, on future platforms, etc. | ||
| * Any money we earn from selling commercial licenses is spent on the development and continued enhancement of Cafu. The code, insight and knowledge that we obtain from additional budget or manpower is directly given back to the community (most prominently in the form of commits to the [[cppdev:gettingstarted|Cafu source code repository]]). | * Any money we earn from selling commercial licenses is spent on the development and continued enhancement of Cafu. The code, insight and knowledge that we obtain from additional budget or manpower is directly given back to the community (most prominently in the form of commits to the [[cppdev:gettingstarted|Cafu source code repository]]). | ||
| Line 104: | Line 79: | ||
| we also believe that it is fair, preserves your rights, and generally helps free software. | we also believe that it is fair, preserves your rights, and generally helps free software. | ||
| - | If you disagree, please [[mailto:info@cafu.de|let us know]] what bothers you. | + | If you disagree, please [[info@cafu.de|let us know]] what bothers you. |
| - | We hope that we can answer your questions and fix whatever is wrong. | + | We'll do our best to answer your questions and fix whatever is wrong. |
| - | But please understand that if you disagree, you cannot use the issue tracker for submitting your patch, and that we thus cannot accept and integrate your contribution to the Cafu Engine. | + | But please understand that if you disagree, you cannot use the issue tracker for submitting your patch, and that we thus cannot accept and integrate your contribution into the Cafu Engine. |
| Line 114: | Line 89: | ||
| * Remember to add any relevant information or docs. | * Remember to add any relevant information or docs. | ||
| - | ** Thank you very much for reading this document. If you have any questions, please [[mailto:info@cafu.de|let us know]]. We're looking forward to your patches! ** :-D | + | ** Thank you very much for reading this document. If you have any questions, please [[info@cafu.de|let us know]]. We're looking forward to your patches! ** :-D |
cppdev/submitpatches.txt · Last modified: 2017-02-05 13:37 by Carsten