Guide to Changelogs - История изменений

imported>SpaceManiac: Remove "Game Resources" category

2020-12-04T03:40:20Z

Remove "Game Resources" category

← Предыдущая версия	Версия от 03:40, 4 декабря 2020
(нет различий)

imported>SpaceManiac: Remove "Game Resources" category

2020-12-04T03:40:20Z

Remove "Game Resources" category

← Предыдущая версия		Версия от 03:40, 4 декабря 2020
Строка 83:		Строка 83:

	{{Contribution guides}}		{{Contribution guides}}
	~~[[Category:Guides]] [[Category:Game Resources]]~~

imported>SpaceManiac: Remove extra indentation from code blocks

2020-11-30T07:19:03Z

Remove extra indentation from code blocks

← Предыдущая версия	Версия от 07:19, 30 ноября 2020
(нет различий)

imported>SpaceManiac: Remove extra indentation from code blocks

2020-11-30T07:19:03Z

Remove extra indentation from code blocks

← Предыдущая версия		Версия от 07:19, 30 ноября 2020
Строка 3:		Строка 3:
	You can add changelog entries by using the following template in the body of your pull request:		You can add changelog entries by using the following template in the body of your pull request:

	:cl: ~~name~~		:cl:
	prefix: text		prefix: text
	prefix: text		prefix: text
	prefix: text		prefix: text
	/:cl:		/:cl:

	Your GitHub username is credited by default, or you can add a name at the end of the <tt>:cl:</tt> line to override it.		Your GitHub username is credited by default, or you can add a name at the end of the <tt>:cl:</tt> line to override it.
Строка 58:		Строка 58:

	'''File content example:'''		'''File content example:'''
	author: Deantwo		author: Deantwo

	delete-after: True		delete-after: True

	changes:		changes:
	- rscadd: "Added laser rifles for everyone."		- rscadd: "Added laser rifles for everyone."
	- rscdel: "Removed everyone's brains."		- rscdel: "Removed everyone's brains."

	=== Updating the Changelog ===		=== Updating the Changelog ===

imported>SpaceManiac в 04:08, 30 ноября 2020

2020-11-30T04:08:31Z

← Предыдущая версия	Версия от 04:08, 30 ноября 2020
(нет различий)

imported>SpaceManiac в 04:08, 30 ноября 2020

2020-11-30T04:08:31Z

← Предыдущая версия		Версия от 04:08, 30 ноября 2020
Строка 1:		Строка 1:
	~~{{note\|This guide thanks~~ to ~~friends from [http~~://~~ss13~~.~~nexisonline.net/wiki/Guide_to_Changelogs /vg/].}}~~		: [[Guide to contributing to the game]]

			You can add changelog entries by using the following template in the body of your pull request:

			:cl: name
			prefix: text
			prefix: text
			prefix: text
			/:cl:

			Your GitHub username is credited by default, or you can add a name at the end of the <tt>:cl:</tt> line to override it.

			Valid prefixes are:

	~~Changelogs are small YAML files that developers create to~~ add ~~their pull requests' changes to the master changelog~~.~~html file~~. ~~A python script run by a maintainer collects all the changes specified and generates the HTML necessary, merging changes by the same author during the same day~~.		* [[File:Tick-circle.png]] add
			* [[File:Cross-circle.png]] del
			* [[File:Bug-minus.png]] fix
			* [[File:Hard-hat-exclamation.png]] wip
			* [[File:Wrench-screwdriver.png]] tweak
			* [[File:Burn-exclamation.png]] experiment
			* [[File:Spell-check.png]] spellcheck
			* [[File:Music-plus.png]] soundadd
			* [[File:Music-minus.png]] sounddel
			* [[File:Image-plus.png]] imageadd
			* [[File:Image-minus.png]] imagedel
			* [[File:Scales_icon.png]] balance
			* [[File:Coding.png]] code
			* [[File:Burn-exclamation.png]] refactor
			* [[File:Chrome-wrench.gif]] config
			* [[File:Ban.png]] admin
			* [[File:Hard-hat-exclamation.png]] server

	~~On the /tg/station Github changelogs can be automatically generated from special formatting in the body of a PR's description.~~

	~~The idea is~~ to ~~reduce merge conflicts caused by two PRs trying to edit the same file~~.		== Advanced information ==
			{{note\|This guide thanks to friends from [http://ss13.nexisonline.net/wiki/Guide_to_Changelogs /vg/].}}

	~~== Creating~~ a ~~Changelog ==~~		Changelogs are small YAML files that developers create to add their pull requests' changes to the master changelog.html file. A python script run by a maintainer collects all the changes specified and generates the HTML necessary, merging changes by the same author during the same day.

	=== Online auto-creation ===		=== Online auto-creation ===
	~~By formatting text~~ in ~~the body of~~ your PR description ~~you can have~~ a ~~changelog~~ .yml file ~~automatically generated for you.~~		On the /tg/station GitHub, a formatted block in your PR's description as described above will cause a bot to automatically generate a <tt>.yml</tt> file.
	Declare the start of a changelog entry with :cl: and close it with /:cl:; anything in between these two tags will included, remember to use prefixes for each line. See below for a list of valid prefixes.
	~~An author can be set after the :cl: tag, if omitted your Github username will be used by default~~.

	~~'''Format example:'''~~		The idea is to reduce merge conflicts caused by two PRs trying to edit the same file.
	~~:cl: Deantwo~~
	~~rscadd: Added laser rifles for everyone~~.
	~~rscdel: Removed everyone's brains.~~
	~~/:cl:~~

	=== Committing a .yml file ===		=== Committing a .yml file ===
Строка 46:		Строка 68:
	=== Updating the Changelog ===		=== Updating the Changelog ===

	:''Only maintainers need to do this.''		''Only maintainers need to do this.''

	* First, install python3, pip, and PyYaml:		* First, install python3, pip, and PyYaml:
Строка 56:		Строка 78:
	* On Linux or other codebases, run <code>python tools/ss13_genchangelog.py html/changelog.html html/changelogs</code>		* On Linux or other codebases, run <code>python tools/ss13_genchangelog.py html/changelog.html html/changelogs</code>

	== Screwed up Changelog ==		=== Screwed up Changelog ===
	If a changelog needs to be edited after merge, a maintainer will need to edit the html/changelogs/.all_changelog.yml file in order to fix the database. (This file is hidden on Linux and Mac OSX.)		If a changelog needs to be edited after merge, a maintainer will need to edit the html/changelogs/.all_changelog.yml file in order to fix the database. (This file is hidden on Linux and Mac OSX.)

	~~== Valid Prefixes ==~~
	~~Any of these prefixes can be used when creating a changelog.~~
	*[[File:Bug-minus.png]] bugfix
	*[[File:Hard-hat-exclamation.png]] wip
	*[[File:Wrench-screwdriver.png]] tweak
	*[[File:Music-plus.png]] soundadd
	*[[File:Music-minus.png]] sounddel
	*[[File:Tick-circle.png]] rscadd
	*[[File:Cross-circle.png]] rscdel
	*[[File:Image-plus.png]] imageadd
	*[[File:Image-minus.png]] imagedel
	*[[File:Spell-check.png]] spellcheck
	*[[File:Burn-exclamation.png]] experiment

	{{Contribution guides}}		{{Contribution guides}}
	[[Category:Guides]] [[Category:Game Resources]]		[[Category:Guides]] [[Category:Game Resources]]

imported>Oranges: /* Updating the Changelog */

2018-04-05T22:00:25Z

Updating the Changelog

← Предыдущая версия	Версия от 22:00, 5 апреля 2018
(нет различий)

imported>Oranges: /* Updating the Changelog */

2018-04-05T22:00:25Z

Updating the Changelog

← Предыдущая версия		Версия от 22:00, 5 апреля 2018
Строка 48:		Строка 48:
	:''Only maintainers need to do this.''		:''Only maintainers need to do this.''

	* First, install ~~python 2.7~~, pip, and PyYaml:		* First, install python3, pip, and PyYaml:
	** After installing python and ensuring it and its Scripts/ folder is in PATH, download and run [https://raw.githubusercontent.com/pypa/pip/master/contrib/get-pip.py get-pip.py] with python.		** After installing python and ensuring it and its Scripts/ folder is in PATH, download and run [https://raw.githubusercontent.com/pypa/pip/master/contrib/get-pip.py get-pip.py] with python.
	** Once pip is installed run the following commands in your terminal		** Once pip is installed run the following commands in your terminal

imported>Oranges: reorder for most likely case first

2016-12-14T08:54:28Z

reorder for most likely case first

← Предыдущая версия	Версия от 08:54, 14 декабря 2016
(нет различий)

imported>Oranges: reorder for most likely case first

2016-12-14T08:54:28Z

reorder for most likely case first

@@ Строка 8: / Строка 8: @@
 == Creating a Changelog ==
 === Committing a .yml file ===
@@ Строка 32: / Строка 43: @@
        - rscadd: "Added laser rifles for everyone."
        - rscdel: "Removed everyone's brains."
 === Updating the Changelog ===