PatchSubmissionGuidelines
Submitting a patch for a large and mature project like Wesnoth can be an even more daunting task than writing the code it delivers.
This page provides some advice and requirements for prospective code contributors seeking the best chance of acceptance for their patches.
Contents
- 1 Technical requirements
- 1.1 All patches should be submitted as GitHub pull requests
- 1.2 Your commits should follow our existing commit contents and message conventions
- 1.3 Add entries to the changelogs summarizing your changes, if necessary
- 1.4 When adding new C++ source code files, make sure to update the most commonly used project files
- 1.5 C++ source code patches must not generate new warnings
- 1.6 Add yourself to the game credits
- 1.7 When changing or adding WML features, provide directions for updating the wiki along with your submission in the tracker
- 2 After submission
- 3 Obtaining help
- 4 See also
Technical requirements
| Are you a newcomer to Git or GitHub, or to the Battle for Wesnoth project? |
|---|
| If so, please see WesnothRepository. |
-
All patches should be submitted as GitHub pull requests
You may post them in the Coder's Corner forum for discussion too, but we need to track their status, and GitHub is better suited for that. See the WesnothRepository page for help with Git and GitHub.
-
Your commits should follow our existing commit contents and message conventions
This is explained in greater detail in the DeveloperGuide section about commits and commit formatting.
-
Add entries to the changelogs summarizing your changes, if necessary
The
changelogfile contains a list of outstanding changes that is published with every release. If you are fixing a bug or adding a feature that is particularly visible or important for players, you should also add an entry to theplayers_changelogfile. See the relevant DeveloperGuide section as well. -
When adding new C++ source code files, make sure to update the most commonly used project files
The development team primarily uses CMake and SCons. The relevant files are
src/CMakeLists.txtandsrc/SConscript. You might look at how existing source code files are handled in each build script to get an idea of the best way to add your own.Please consider updating the other build environments under
projectfiles/, e.g. Visual C++, as well. -
C++ source code patches must not generate new warnings
Wesnoth has a large number of compiler warnings enabled, and all of them are useful. If your code causes new warnings during build, you will be required to fix them.
-
Add yourself to the game credits
Including your name and/or username(s) makes it easier for the development team and the community at large to recognize your contributions. New contributors (i.e., those without commit access) should add themselves to the Miscellaneous Contributors section of the credits file (
data/core/about.cfg), making sure to follow alphabetical order with respect to the first character that will be displayed. -
When changing or adding WML features, provide directions for updating the wiki along with your submission in the tracker
This allows us to provide content creators with up-to-date information about WML features, even if you cannot be around in time for the commit or the next release.
After submission
-
Be patient, sometimes we are not very responsive
The Wesnoth developers live on different locations across the globe and have other matters to attend to, most of the time. It may happen that your patch is assigned to a developer who is currently unable to dedicate much time to reviewing it. If you feel that it takes much too long for us to respond, contact us in #wesnoth-dev on irc.freenode.net.
-
Don't be surprised if we discuss the patch a lot
Thus, you should leave us a way to contact you, by noting your forums username or email address. We recommend that you join the
#wesnoth-devchannel onirc.freenode.netregularly so we can contact you in real time if needed. -
Sometimes patches are rejected, please don't be surprised or offended if this happens
If your patch introduces new errors or bugs, if the feature you implemented isn't considered an improvement, or if we couldn't contact you with our questions and recommendations, the pull request will be denied. This can usually be averted if you discuss your idea on #wesnoth-dev, where the developers will point out these issues. If your pull request is denied, don't let that discourage you, though!
Obtaining help
-
If you encounter any issues or need additional guidance when preparing your patch...
...the easiest way is to ask the developers on the aforementioned IRC channel,
#wesnoth-dev. You can join#wesnoth-devin your Web browser via this link: -
If you know who is responsible for the code that your patch changes...
...please prefix their IRC nick in front of your question -- else your message could be overlooked.
-
If your patch has a major impact on Wesnoth...
...the developer mailing list might be more appropriate, because all subscribed developers will be notified: