PatchSubmissionGuidelines - Revision history

Soliton: /* Obtaining help */

2023-09-27T12:26:04Z

Obtaining help

← Older revision		Revision as of 12:26, 27 September 2023
Line 74:		Line 74:
	<li>		<li>
	<h3>If you encounter any issues or need additional guidance when preparing your patch...</h3>		<h3>If you encounter any issues or need additional guidance when preparing your patch...</h3>
	<p>...the easiest way is to ask the developers on the aforementioned IRC channel, '''<code>#wesnoth-dev</code>'''. You can join <code>#wesnoth-dev</code> in your Web browser via this link: {{FeaturedURL\|https://~~webchat~~.~~freenode~~.~~net~~/~~?channels{{=}}~~wesnoth-dev}}</p>		<p>...the easiest way is to ask the developers on the aforementioned IRC channel, '''<code>#wesnoth-dev</code>'''. You can join <code>#wesnoth-dev</code> in your Web browser via this link: {{FeaturedURL\|https://web.libera.chat/#wesnoth-dev}}</p>
	</li>		</li>

Line 80:		Line 80:
	<h3>If you know who is responsible for the code that your patch changes...</h3>		<h3>If you know who is responsible for the code that your patch changes...</h3>
	<p>...please prefix their IRC nick in front of your question -- else your message could be overlooked.</p>		<p>...please prefix their IRC nick in front of your question -- else your message could be overlooked.</p>
	~~</li>~~

	~~<li>~~
	~~<h3>If your patch has a major impact on Wesnoth...</h3>~~
	~~<p>...the developer mailing list might be more appropriate, because all subscribed developers will be notified: {{FeaturedURL\|https://gna.org/mail/?group{{=}}wesnoth}}</p>~~
	</li>		</li>

Soliton: /* After submission */

2023-09-27T12:06:24Z

After submission

← Older revision		Revision as of 12:06, 27 September 2023
Line 53:		Line 53:
	<li>		<li>
	<h3>Be patient, sometimes we are not very responsive</h3>		<h3>Be patient, sometimes we are not very responsive</h3>
	<p>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~~.'''</p>		<p>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.libera.chat.'''</p>
	</li>		</li>

	<li>		<li>
	<h3>Don't be surprised if we discuss the patch a lot</h3>		<h3>Don't be surprised if we discuss the patch a lot</h3>
	<p>Thus, you should '''leave us a way to contact you''', by noting your forums username or email address. We recommend that you join the '''<code>#wesnoth-dev</code>''' channel on '''<code>irc.~~freenode~~.~~net~~</code>''' regularly so we can contact you in real time if needed.</p>		<p>Thus, you should '''leave us a way to contact you''', by noting your forums username or email address. We recommend that you join the '''<code>#wesnoth-dev</code>''' channel on '''<code>irc.libera.chat</code>''' regularly so we can contact you in real time if needed.</p>
	</li>		</li>

8680: /* Technical requirements */

2015-07-30T21:46:19Z

Technical requirements

← Older revision		Revision as of 21:46, 30 July 2015
Line 5:		Line 5:
	== Technical requirements ==		== Technical requirements ==

	{{~~SideBox\|'''Are you a newcomer to Git or GitHub, or to the <cite>Battle for Wesnoth</cite> project?''' If so, please see <cite>[[WesnothRepository]]</cite>.~~}}		{{NewDevsGoHereSidebox}}

	<ul>		<ul>

8680 at 21:37, 30 July 2015

2015-07-30T21:37:50Z

Show changes

Shadowm: /* Technical requirements */

2015-07-24T23:43:10Z

Technical requirements

← Older revision		Revision as of 23:43, 24 July 2015
Line 3:		Line 3:
	== Technical requirements ==		== 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 [http://wiki.wesnoth.org/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.		* '''Your commits should follow our existing commit contents and message conventions'''<br>This is explained in greater detail in the [[DeveloperGuide#Commits\|developer's guide]] section about commits and commit formatting.

			* '''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. See the relevant section in the [[DeveloperGuide#Changelogs_and_release_notes\|developer's guide]] as well.

	* '''When adding new C++ source code files, make sure to update the most commonly used project files'''<br>The development team primarily uses CMake and SCons. The relevant files are <code>src/CMakeLists.txt</code> and <code>src/SConscript</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. Visual C++, as well.		* '''When adding new C++ source code files, make sure to update the most commonly used project files'''<br>The development team primarily uses CMake and SCons. The relevant files are <code>src/CMakeLists.txt</code> and <code>src/SConscript</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. Visual C++, as well.

Shadowm: /* Obtaining help */

2015-07-24T23:38:47Z

Obtaining help

← Older revision		Revision as of 23:38, 24 July 2015
Line 26:		Line 26:

	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<br>		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<br>
	~~http~~://webchat.freenode.net/?channels=wesnoth-dev		https://webchat.freenode.net/?channels=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 your message could be overlooked.		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.

Aquileia: Derate VC to minor build environment (although several devs use it, not even all of them care to add their changes in the project file...)

2015-06-24T08:17:32Z

Derate VC to minor build environment (although several devs use it, not even all of them care to add their changes in the project file...)

← Older revision		Revision as of 08:17, 24 June 2015
Line 7:		Line 7:
	* '''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.		* '''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++~~. 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.		* '''When adding new C++ source code files, make sure to update the most commonly used project files'''<br>The development team primarily uses CMake and SCons. The relevant files are <code>src/CMakeLists.txt</code> and <code>src/SConscript</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. Visual C++, 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.		* '''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.

Aquileia: Fix freenode link, now correctly defaults to #wesnoth-dev

2014-04-25T20:10:39Z

Fix freenode link, now correctly defaults to #wesnoth-dev

← Older revision		Revision as of 20:10, 25 April 2014
Line 26:		Line 26:

	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<br>		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<br>
	http://webchat.freenode.net/?~~channel~~=wesnoth-dev		http://webchat.freenode.net/?channels=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 your message could be overlooked.		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.

Aquileia: move link to a separate line

2014-04-05T21:00:52Z

move link to a separate line

← Older revision		Revision as of 21:00, 5 April 2014
Line 25:		Line 25:
	== Obtaining help ==		== 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 e.g. log in via		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<br>
	http://webchat.freenode.net/?channel=wesnoth-dev		http://webchat.freenode.net/?channel=wesnoth-dev

Aquileia: Overwrite page with User:Shadowmaster/PatchSubmissionGuidelines

2014-04-05T20:59:24Z

Overwrite page with User:Shadowmaster/PatchSubmissionGuidelines

← Older revision		Revision as of 20:59, 5 April 2014
Line 1:		Line 1:
	~~Adapted from http://www~~.~~wesnoth~~.~~org/forum/viewtopic.php?f=10&t=9979~~		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.

	~~The exact mechanics of generating a patch on your development machine will vary according to what operating system and tools you are using. [[WesnothRepository]] describes some common scenarios.~~		== Technical requirements ==

	* '''All patches should be submitted ~~at patches.wesnoth.org~~'''		* '''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.
	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~~

	~~It even records precisely~~ the ~~commit against which it was generated~~, ~~it makes things really easy for us..~~.		* '''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.

	* '''~~Don't forget to add an entry~~ to the ~~Changelog'''~~		* '''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.
	* '''~~If you add a file~~, ~~don't forget to update src/SConscript~~, src/CMakeLists.txt, and projectfiles/VC9/wesnoth.vcproj ~~'''~~

	* '''~~Add yourself in about.cfg~~'''		* '''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.
	~~Including your name~~ and~~/or nickname(s) makes it easier for us to recognize~~ your ~~contributions.~~
	~~New contributors (i.e.~~, ~~those without commit access) 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~~'''		* '''Add yourself to the game credits'''<br>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 (<code>data/core/about.cfg</code>), making sure to follow alphabetical order with respect to the first character that will be displayed.

	* '''~~Be patient~~, ~~sometimes we are not very responsive'''~~		* '''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.
	* '''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'''		== After submission ==
	~~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.~~

	* '''Sometimes patches are rejected, don't be ~~suprised~~ if it happens'''		* '''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 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 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 ==

			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
			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 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.

	== See also ==		== See also ==

	* [[HackingWesnoth]]		* [[HackingWesnoth]]
	* [[CodingStandards]]		* [[CodingStandards]]
	* [[GoodCommitCommentingPractice]]
	* [[EasyCoding]]		* [[EasyCoding]]
	* [[DeveloperResources]]		* [[DeveloperResources]]

	[[Category:Development]]		[[Category:Development]]