Guide to Changelogs: Difference between revisions

Jump to navigation Jump to search
imported>Deantwo
(→‎Pull Requests: Updated a little to be more understandable. Added examples for file names and file contect.)
imported>Paprika
Line 10: Line 10:
PR changelogs are temporary and just get deleted after they're merged into the master changelog.
PR changelogs are temporary and just get deleted after they're merged into the master changelog.


# Create <code>html/changelogs/''USERNAME''-PR-''####''.yml</code>.
# Create <code>html/changelogs/''USERNAME'-'BRANCHNAME''.yml</code>.
## Go to <code>/master/html/changelogs/</code> on your branch.
## Go to <code>/master/html/changelogs/</code> on your branch.
## Create file <code>''USERNAME''-PR-''####''.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>
##* 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 too. Also prevents conflicts since two files won't have the same name.
##* 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/tgstation/-tg-station/blob/master/html/changelogs/example.yml this].
# Fill it out.
# Fill it out.
Anonymous user

Navigation menu