DeveloperGuide - Revision history

Doofus-01: /* See also */

2025-03-23T03:27:43Z

Soliton: /* Commit messages */

2025-03-03T16:09:27Z

Commit messages

← Older revision		Revision as of 16:09, 3 March 2025
Line 28:		Line 28:

	A good commit should not only contain good changes, but also include a helpful description of them for other developers, people tracking regressions, project maintainers, and even yourself in the future. There are many style guides on the Web describing best practices for documenting your Git commits.		A good commit should not only contain good changes, but also include a helpful description of them for other developers, people tracking regressions, project maintainers, and even yourself in the future. There are many style guides on the Web describing best practices for documenting your Git commits.

			Regardless of style, usually the most important info is the '''goal''' of the commit. It's less important to describe what you did (you can just look at the diff for that; though for the summary line it's still useful) and more important '''why''' you did it.

	For Wesnoth in particular, the general consensus is that contributors should adhere to the following rules:		For Wesnoth in particular, the general consensus is that contributors should adhere to the following rules:

Soliton: /* Bugs management */

2025-03-03T16:02:39Z

Bugs management

← Older revision		Revision as of 16:02, 3 March 2025
Line 50:		Line 50:

	== Bugs management ==		== Bugs management ==
	* ~~Change Status field of fixed~~ bugs ~~to "Fixed" after pushing upstream~~		* Close bugs once a fix is pushed.
	* Change Open/Closed field of fixed bugs to "Closed" after a ~~release including the relevant commits has been published. See [[ReportingBugs#Bug_protocol]] for details~~.
	* Check regularly if there are new bugs relevant to your code and, if any, assign them to you.		* Check regularly if there are new bugs relevant to your code and, if any, assign them to you.

Soliton: /* Dependencies */

2025-03-03T15:57:27Z

Dependencies

← Older revision		Revision as of 15:57, 3 March 2025
Line 45:		Line 45:

	== Dependencies ==		== Dependencies ==
	* Any changes to Wesnoth's build and run-time dependencies must be discussed ~~on the developers mailing list~~ first.		* Any changes to Wesnoth's build and run-time dependencies must be discussed first.
	* Update the CMake and SCons recipes accordingly.		* Update the CMake and SCons recipes accordingly.
	* Changes must be mentioned in the ~~RELEASE_NOTES file~~, so they can be included in the forum announcement for the next release, and in the emails to packagers.		* Changes must be mentioned in the changelog, so they can be included in the forum announcement for the next release, and in the emails to packagers.

	== Bugs management ==		== Bugs management ==

Egallager: /* See also */ link to ReferenceWML

2023-12-16T02:43:59Z

Pentarctagon: /* Changelog and release notes */

2023-12-11T15:20:06Z

Changelog and release notes

← Older revision		Revision as of 15:20, 11 December 2023
Line 23:		Line 23:
	We provide a <b>changelog</b> at the root of the Wesnoth distribution and Git checkouts. It contains all changes, except for those that are only relevant to mainline developers and which are not expected to impact players or creators in any way.		We provide a <b>changelog</b> at the root of the Wesnoth distribution and Git checkouts. It contains all changes, except for those that are only relevant to mainline developers and which are not expected to impact players or creators in any way.

	It is your responsibility to update the changelog as you see fit for every commit. ~~For large changes spread over long series~~ of ~~commits~~, ~~you will probably prefer~~ to ~~commit your changelog additions in~~ a ~~separate last commit~~ to ~~avoid or mitigate conflicts when merging upstream~~.		It is your responsibility to update the changelog as you see fit for every commit. To avoid any chance of merge conflicts due to the changelog, it is recommended to add a file to the changelog_entries folder at the root of the repository rather than updating the changelog directly.

	=== Commit messages ===		=== Commit messages ===

Pentarctagon: /* Changelog and release notes */

2023-12-11T15:18:48Z

Changelog and release notes

← Older revision		Revision as of 15:18, 11 December 2023
Line 24:		Line 24:

	It is your responsibility to update the changelog as you see fit for every commit. For large changes spread over long series of commits, you will probably prefer to commit your changelog additions in a separate last commit to avoid or mitigate conflicts when merging upstream.		It is your responsibility to update the changelog as you see fit for every commit. For large changes spread over long series of commits, you will probably prefer to commit your changelog additions in a separate last commit to avoid or mitigate conflicts when merging upstream.

	Important changes that might be expected to inconvenience or confuse players (including those building from source) or content creators, major bug fixes, and noteworthy feature additions for a future release should be mentioned and explained in <b>RELEASE_NOTES</b> as well, so that the release team can include this information in official announcements. See the contents of the file for instructions.

	=== Commit messages ===		=== Commit messages ===

Soliton: /* General */ mailing list is not really used anymore

2023-05-23T14:49:45Z

General: mailing list is not really used anymore

← Older revision		Revision as of 14:49, 23 May 2023
Line 8:		Line 8:

	* [[WesnothRepository#Push_access\|Set up developer access to the repository]], if applicable.		* [[WesnothRepository#Push_access\|Set up developer access to the repository]], if applicable.
	* Subscribe to the [https://mailman.wesnoth.org/listinfo/dev wesnoth-dev mailing list], wherein major announcements are made and project-changing discussions take place.
	* Participate in the #development channel on [https://discord.gg/battleforwesnoth Discord] as well as #wesnoth-dev IRC channel on irc.libera.chat to coordinate with other developers. Bots report commits and regression testing status, and other developers may ask you questions or provide feedback.		* Participate in the #development channel on [https://discord.gg/battleforwesnoth Discord] as well as #wesnoth-dev IRC channel on irc.libera.chat to coordinate with other developers. Bots report commits and regression testing status, and other developers may ask you questions or provide feedback.

Vasya: update IRC to libera.chat (from the old freenode)

2021-05-24T07:31:34Z

update IRC to libera.chat (from the old freenode)

← Older revision		Revision as of 07:31, 24 May 2021
Line 9:		Line 9:
	* [[WesnothRepository#Push_access\|Set up developer access to the repository]], if applicable.		* [[WesnothRepository#Push_access\|Set up developer access to the repository]], if applicable.
	* Subscribe to the [https://mailman.wesnoth.org/listinfo/dev wesnoth-dev mailing list], wherein major announcements are made and project-changing discussions take place.		* Subscribe to the [https://mailman.wesnoth.org/listinfo/dev wesnoth-dev mailing list], wherein major announcements are made and project-changing discussions take place.
	* Participate in the #development channel on [https://discord.gg/battleforwesnoth Discord] as well as #wesnoth-dev IRC channel on irc.~~freenode~~.~~net~~ to coordinate with other developers. Bots report commits and regression testing status, and other developers may ask you questions or provide feedback.		* Participate in the #development channel on [https://discord.gg/battleforwesnoth Discord] as well as #wesnoth-dev IRC channel on irc.libera.chat to coordinate with other developers. Bots report commits and regression testing status, and other developers may ask you questions or provide feedback.

	== Commits ==		== Commits ==

Pentarctagon: /* General */

2021-01-23T04:57:53Z

General

← Older revision		Revision as of 04:57, 23 January 2021
Line 9:		Line 9:
	* [[WesnothRepository#Push_access\|Set up developer access to the repository]], if applicable.		* [[WesnothRepository#Push_access\|Set up developer access to the repository]], if applicable.
	* Subscribe to the [https://mailman.wesnoth.org/listinfo/dev wesnoth-dev mailing list], wherein major announcements are made and project-changing discussions take place.		* Subscribe to the [https://mailman.wesnoth.org/listinfo/dev wesnoth-dev mailing list], wherein major announcements are made and project-changing discussions take place.
	* Participate in the #wesnoth-dev IRC channel on irc.freenode.net to coordinate with other developers. Bots report commits and regression testing status, and other developers may ask you questions or provide feedback.		* Participate in the #development channel on [https://discord.gg/battleforwesnoth Discord] as well as #wesnoth-dev IRC channel on irc.freenode.net to coordinate with other developers. Bots report commits and regression testing status, and other developers may ask you questions or provide feedback.

	== Commits ==		== Commits ==

← Older revision		Revision as of 03:27, 23 March 2025
Line 62:		Line 62:
	* [[CompatibilityStandards#Deprecation_levels_-_When_to_remove_deprecated_features\|DeprecationLevels]]		* [[CompatibilityStandards#Deprecation_levels_-_When_to_remove_deprecated_features\|DeprecationLevels]]
	* [[ReferenceWML]]		* [[ReferenceWML]]
			* [[ImageMetadata]]
	[[Category:Development]]		[[Category:Development]]

← Older revision		Revision as of 02:43, 16 December 2023
Line 60:		Line 60:
	* [[Project]]		* [[Project]]
	* [[CompatibilityStandards#Deprecation_levels_-_When_to_remove_deprecated_features\|DeprecationLevels]]		* [[CompatibilityStandards#Deprecation_levels_-_When_to_remove_deprecated_features\|DeprecationLevels]]
			* [[ReferenceWML]]
	[[Category:Development]]		[[Category:Development]]