Difference between revisions of "PatchSubmissionGuidelines"
ShikadiQueen (talk | contribs) m (Mention that adding oneself to about.cfg involves this strange thing called 'alphabetical order'; also, it's 'Miscellaneous Contributors' nowadays) |
ShikadiQueen (talk | contribs) (Replaced first singular person with first plural person, other grammar/content revisions) |
||
| Line 2: | Line 2: | ||
* '''All patches should be submitted at patches.wesnoth.org''' | * '''All patches should be submitted at patches.wesnoth.org''' | ||
| − | You can post them | + | You can post them in the [http://www.wesnoth.org/forum/viewtopic.php?f=10&t=9979 Coder's Corner] subforum too for discussion, but we need to track what is their status and p.w.o helps a lot |
* '''Patches should be generated using "svn diff"''' | * '''Patches should be generated using "svn diff"''' | ||
| − | SVN provides a cool command to generate diff | + | SVN provides a cool command to generate diff. We usually run "svn diff >mypatch.patch" to create patches, and it's all nice and ready. |
| − | It even records precisely the commit against which it was generated, it makes things really easy for | + | |
| + | It even records precisely the commit against which it was generated, it makes things really easy for us... | ||
* '''Don't forget to add an entry to the Changelog''' | * '''Don't forget to add an entry to the Changelog''' | ||
| − | * ''' | + | * '''If you add a file, don't forget to update src/Makefile.am, src/SConscript and src/CMakeLists.txt''' |
* '''Add yourself in about.cfg''' | * '''Add yourself in about.cfg''' | ||
| − | Including your name and/or | + | Including your name and/or nickname(s) makes it easier for us to recognize your contributions. |
| − | New contributors should add themselves to the ''Miscellaneous Contributors'' section of the about file (data/core/about.cfg). Please keep the alphabetical order while doing it | + | New contributors should add themselves to the ''Miscellaneous Contributors'' section of the about file (data/core/about.cfg). Please keep the alphabetical order while doing it! |
* '''When changing WML, please add a pointer in the wiki to where it should be updated when commited''' | * '''When changing WML, please add a pointer in the wiki to where it should be updated when commited''' | ||
| − | * '''Be patient, | + | * '''Be patient, sometimes we are not very responsive''' |
* '''Don't be suprised if we discuss the patch a lot''' | * '''Don't be suprised if we discuss the patch a lot''' | ||
| − | Thus, you should leave us a way to contact you, either a forum nick, an email adress, or submit with a registered gna account. | + | Thus, you should leave us a way to contact you, either a forum nick, an email adress, or submit with a registered gna account. We recommend that you join the #wesnoth-dev channel on irc.freenode.net regularly so we can contact you in real time if needed. |
* '''The patch should generate no warnings''' | * '''The patch should generate no warnings''' | ||
| − | Wesnoth has a large number of warnings enabled, all of them are useful. If your code spits | + | Wesnoth has a large number of compiler warnings enabled, and all of them are useful. If your code spits warnings, please have a look, and ask yourself why you are doing whatever causes the warning. |
| − | * '''When adding a file, don't forget Makefile.am''' | + | * '''When adding a file, don't forget src/Makefile.am, src/SConscript and src/CMakeLists.txt''' |
| − | It makes things simpler for | + | It makes things simpler for us, but it's often forgotten. |
* '''Sometimes patches are rejected, don't be suprised if it happens''' | * '''Sometimes patches are rejected, don't be suprised if it happens''' | ||
Revision as of 17:43, 31 August 2009
Copied from http://www.wesnoth.org/forum/viewtopic.php?f=10&t=9979
- All patches should be submitted at patches.wesnoth.org
You can post them in the Coder's Corner subforum too for discussion, but we need to track what is their status and p.w.o helps a lot
- Patches should be generated using "svn diff"
SVN provides a cool command to generate diff. We usually run "svn diff >mypatch.patch" to create patches, and it's all nice and ready.
It even records precisely the commit against which it was generated, it makes things really easy for us...
- Don't forget to add an entry to the Changelog
- If you add a file, don't forget to update src/Makefile.am, src/SConscript and src/CMakeLists.txt
- Add yourself in about.cfg
Including your name and/or nickname(s) makes it easier for us to recognize your contributions. New contributors should add themselves to the Miscellaneous Contributors section of the about file (data/core/about.cfg). Please keep the alphabetical order while doing it!
- When changing WML, please add a pointer in the wiki to where it should be updated when commited
- Be patient, sometimes we are not very responsive
- Don't be suprised if we discuss the patch a lot
Thus, you should leave us a way to contact you, either a forum nick, an email adress, or submit with a registered gna account. We recommend that you join the #wesnoth-dev channel on irc.freenode.net regularly so we can contact you in real time if needed.
- The patch should generate no warnings
Wesnoth has a large number of compiler warnings enabled, and all of them are useful. If your code spits warnings, please have a look, and ask yourself why you are doing whatever causes the warning.
- When adding a file, don't forget src/Makefile.am, src/SConscript and src/CMakeLists.txt
It makes things simpler for us, but it's often forgotten.
- Sometimes patches are rejected, don't be suprised if it happens