User:Shadowm/PatchSubmissionGuidelines - Revision history

Egallager: link cleanup

2023-05-03T04:24:50Z

link cleanup

Shadowm: Shadowm moved page User:Shadowmaster/PatchSubmissionGuidelines to User:Shadowm/PatchSubmissionGuidelines: Automatically moved page while renaming the user "Shadowmaster" to "Shadowm"

2018-02-27T06:23:52Z

Shadowm moved page User:Shadowmaster/PatchSubmissionGuidelines to User:Shadowm/PatchSubmissionGuidelines: Automatically moved page while renaming the user "Shadowmaster" to "Shadowm"

Aquileia: /* Obtaining help */

2014-04-05T20:43:20Z

‎Obtaining help

Aquileia: /* Obtaining help */

2014-04-05T20:40:58Z

‎Obtaining help

Aquileia: rejection explanation

2014-04-05T20:23:30Z

rejection explanation

Aquileia: Mention other projectfiles

2014-04-05T20:01:45Z

Mention other projectfiles

Lipk: /* After submission */

2014-02-03T19:55:29Z

‎After submission

Lipk: /* Technical requirements */

2014-02-03T19:45:20Z

‎Technical requirements

Shadowm: Split in sections, added an intro blurb, minor rewording

2012-12-27T22:45:49Z

Split in sections, added an intro blurb, minor rewording

Shadowm at 22:19, 27 December 2012

2012-12-27T22:19:44Z

@@ Line 5: / Line 5: @@
 == Technical requirements ==
-* '''All patches should be submitted as GitHub pull requests'''<br>You may post them in the [http://forums.wesnoth.org/viewtopic.php?f=10 Coder's Corner] forum for discussion too, but we need to track their status, and GitHub is better suited for this. See [http://wiki.wesnoth.org/WesnothRepository this] page for help on using git and GitHub.
+* '''All patches should be submitted as GitHub pull requests'''<br>You may post them in the [http://forums.wesnoth.org/viewtopic.php?f=10 Coder's Corner] forum for discussion too, but we need to track their status, and GitHub is better suited for this. See [[WesnothRepository|this]] page for help on using git and GitHub.
 * '''Add entries to the changelogs summarizing your changes if necessary'''<br>The <code>changelog</code> file 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 the <code>players_changelog</code> file.

@@ Line 30: / Line 30: @@
 http://webchat.freenode.net/?channel=wesnoth-dev
-If you know who is responsible for the code your patch addresses, please prefix their IRC name in front of your question - else they could overlook your message.
+If you know who is responsible for the code your patch addresses, please prefix their IRC name in front of your question - else your message could be overlooked.
 If your patch has a major impact on Wesnoth, the developer mailing list on https://gna.org/mail/?group=wesnoth might be more appropriate as all developers will be notified.

@@ Line 27: / Line 27: @@
 == Obtaining help ==
-If you encounter any issues or need additional guidance when preparing your patch, you may ask the developers on #wesnoth-dev on irc.freenode.net ''('''FIXME''': include the forums and devs ML here?)''. ''('''FIXME''': could really use a link with a guide to using IRC and asking questions in #wesnoth-dev here, e.g. explaining the timezones issue, idlers, etc.)''
+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 e.g. log in via
 == See also ==

@@ Line 21: / Line 21: @@
 * '''Be patient, sometimes we are not very responsive'''<br>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 way too long for us to respond, contact us in #wesnoth-dev on irc.freenode.net.
-* '''Don't be suprised if we discuss the patch a lot'''<br>Thus, you should leave us a way to contact you, either a forum nick, an email adress, or submit with a registered Gna.org 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.
+* '''Don't be surprised if we discuss the patch a lot'''<br>Thus, you should leave us a way to contact you, either a forum nick, an email address, or submit with a registered Gna.org account. We recommend that you join the #wesnoth-dev channel on <code>irc.freenode.net</code> regularly so we can contact you in real time if needed.
-* '''Sometimes patches are rejected, don't be suprised if this happens'''<br>''('''FIXME''': common rejection reasons, some words of encouragement.)''
+* '''Sometimes patches are rejected, don't be surprised if this happens'''<br>If your patch introduces new errors or bugs, the feature you implemented isn't considered an improvement or we couldn't contact you with our questions and recommendations, the pull request will be closed without merging. This can usually be averted if you discuss your idea on #wesnoth-dev as the developers will point out these issues. If it happens, don't let this discourage you; it's just necessary to ensure Wesnoth remains enjoyable.
 == Obtaining help ==

@@ Line 9: / Line 9: @@
 * '''Add entries to the changelogs summarizing your changes if necessary'''<br>The <code>changelog</code> file 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 the <code>players_changelog</code> file.
-* '''When adding new C++ source code files, make sure to update the most commonly used project files'''<br>The development team primarily uses CMake, SCons, and Visual C++ 2008. The relevant files are <code>src/CMakeLists.txt</code>, <code>src/SConscript</code>, and <code>projectfiles/VC9/wesnoth.vcproj</code>. You may take a 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.
+* '''When adding new C++ source code files, make sure to update the most commonly used project files'''<br>The development team primarily uses CMake, SCons, and Visual C++. The relevant files are <code>src/CMakeLists.txt</code>, <code>src/SConscript</code>, and <code>projectfiles/VC9/wesnoth.vcproj</code>. You may take a 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 <code>projectfiles/</code>, e.g. Code Blocks, as well.
 * '''C++ source code patches must not generate new warnings'''<br>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.

← Older revision	Revision as of 06:23, 27 February 2018
(No difference)

@@ Line 19: / Line 19: @@
 == After submission ==
-* '''Be patient, sometimes we are not very responsive'''<br>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.<br>''('''FIXME''': alternatively, it may happen that the patch is never assigned to anyone. What to do about this?)''
+* '''Be patient, sometimes we are not very responsive'''<br>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 way too long for us to respond, contact us in #wesnoth-dev on irc.freenode.net.
 * '''Don't be suprised if we discuss the patch a lot'''<br>Thus, you should leave us a way to contact you, either a forum nick, an email adress, or submit with a registered Gna.org 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.

@@ Line 1: / Line 1: @@
 ''This is an updated version of the [[PatchSubmissionGuidelines]] I'm preparing here. This document is '''not''' authoritative until it replaces the current [[PatchSubmissionGuidelines]] at their current location.<br><br>-- shadowmaster''
-* '''All patches should be submitted to [http://patches.wesnoth.org patches.wesnoth.org]'''<br>You may post them in the [http://forums.wesnoth.org/viewtopic.php?f=10 Coder's Corner] forum for discussion too, but we need to track their status, and patches.wesnoth.org helps a lot.
+== Technical requirements ==
 * '''Add entries to the changelogs summarizing your changes if necessary'''<br>The <code>changelog</code> file 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 the <code>players_changelog</code> file.
@@ Line 14: / Line 17: @@
 * '''Patches should be generated using "svn diff"'''<br>SVN provides a handy command to generate a unified diff from your local changes. Running <code>svn diff > mypatch.patch</code> is enough to create a proper patch file for submitting. It even records precisely the commit against which it was generated, which makes things easier for us.
-* '''When changing or adding WML features, please provide directions for updating the wiki when the patch is committed'''<br>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.
+* '''When changing or adding WML features, provide directions for updating the wiki along with your submission in the tracker'''<br>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.
 * '''Be patient, sometimes we are not very responsive'''<br>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.<br>''('''FIXME''': alternatively, it may happen that the patch is never assigned to anyone. What to do about this?)''
@@ Line 21: / Line 26: @@
 * '''Sometimes patches are rejected, don't be suprised if this happens'''<br>''('''FIXME''': common rejection reasons, some words of encouragement.)''
 == See also ==
 * [[HackingWesnoth]]
 * [[CodingStandards]]