Guide to Changelogs - Revision history

Bokkiewokkie: make link NSV

2021-03-11T10:22:40Z

make link NSV

2018-04-05T22:00:25Z

Updating the Changelog

2016-12-14T08:54:28Z

reorder for most likely case first

2015-11-25T03:36:54Z

Online auto-creation

2015-11-24T04:41:42Z

2015-02-08T20:11:05Z

Pull Requests: Tiny fix for humors sake.

2015-02-08T20:03:15Z

Pull Requests

2015-02-08T20:02:45Z

Pull Requests

2015-02-08T20:01:52Z

Pull Requests

2015-02-08T20:01:06Z

Pull Requests

@@ Line 28: / Line 28: @@
 ##* Example: <code>Deantwo-BrainlessShooting.yml</code>
 ##* File name is not super important but helps the maintainers know who made the file and which PR it is related to. Also prevents conflicts since two files won't have the same name.
-# Copy the contents of [https://github.com/tgstation/-tg-station/blob/master/html/changelogs/example.yml this].
+# Copy the contents of [https://github.com/beestation/NSV13/blob/master/html/changelogs/example.yml this].
 # Fill it out.
 #* Make sure to set delete-after to true.

@@ Line 48: / Line 48: @@
 :''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.
 ** Once pip is installed run the following commands in your terminal

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

@@ Line 37: / Line 37: @@
 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:'''

@@ Line 2: / Line 2: @@
 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.
 The idea is to reduce merge conflicts caused by two PRs trying to edit the same file.
@@ Line 7: / Line 9: @@
 == Creating a Changelog ==
-=== Pull Requests ===
+=== Committing a .yml file ===
 PR changelogs are temporary and just get deleted after they're merged into the master changelog.
@@ Line 31: / Line 33: @@
        - rscdel: "Removed everyone's brains."
-=== Maintainer Changelogs ===
+=== Online auto-creation ===
-Maintainers can have their own changelogs.  Follow the same directions as above, but use USERNAME.yml and leave delete-after false.
+By formatting text in the body of your PR description you can have a changelog .yml file automatically generated for you.
 === Updating the Changelog ===
@@ Line 48: / Line 59: @@
 == 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.)
 {{Contribution guides}}
 [[Category:Guides]] [[Category:Game Resources]]

@@ Line 12: / Line 12: @@
 # Create <code>html/changelogs/''USERNAME-BRANCHNAME''.yml</code>.
 ## Go to <code>/master/html/changelogs/</code> on your branch.
-## Create file <code>''USERNAME-BRANCHNAME''.yml</code> in the folder, where 'BRANCHNAME' the name of the branch.
+## Create file <code>''USERNAME-BRANCHNAME''.yml</code> in the folder, where 'BRANCHNAME' the name of the branch on your fork and 'USERNAME' is your github username.
 ##* Example: <code>Deantwo-ChemMasterGetsGloomy.yml</code>
 ##* File name is not super important but helps the maintainers know who made the file and which PR it is related to. Also prevents conflicts since two files won't have the same name.

@@ Line 10: / Line 10: @@
 PR changelogs are temporary and just get deleted after they're merged into the master changelog.
-# Create <code>html/changelogs/''USERNAME'-'BRANCHNAME''.yml</code>.
+# Create <code>html/changelogs/''USERNAME-BRANCHNAME''.yml</code>.
 ## Go to <code>/master/html/changelogs/</code> on your branch.
-## Create file <code>''USERNAME'-'BRANCHNAME''.yml</code> in the folder, where #### is the number or ID of your PR or the name of the branch.
+## Create file <code>''USERNAME-BRANCHNAME''.yml</code> in the folder, where #### is the number or ID of your PR or the name of the branch.
 ##* Example: <code>Deantwo-PR-7445.yml</code> or <code>Deantwo-PR-ChemMasterGetsGloomy.yml</code>
 ##* File name is not super important but helps the maintainers know who made the file and which PR it is related to. Also prevents conflicts since two files won't have the same name.