Guide to Changelogs: Difference between revisions
→Pull Requests: Updated a little to be more understandable. Added examples for file names and file contect.
imported>Oranges m (You should also change author field) |
imported>Deantwo (→Pull Requests: Updated a little to be more understandable. Added examples for file names and file contect.) |
||
| 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 html/changelogs/USERNAME-PR-###.yml, where ### is the number or ID of your PR or the name of the branch | # Create <code>html/changelogs/''USERNAME''-PR-''####''.yml</code>. | ||
## 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. | |||
##* 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. | |||
# 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. | ||
#* Make sure to set delete-after to true. | #* Make sure to set delete-after to true. | ||
#* Also ensure you update the author name so you get credited appropriately | #* Also ensure you update the author name so you get credited appropriately. | ||
# '''PROOFREAD.''' Changelog entries are final after they're merged. | # '''PROOFREAD.''' Changelog entries are final after they're merged. | ||
# Add it to git so it's included with your PR. | # Add it to git so it's included with your PR. | ||
'''File content example:''' | |||
author: Deantwo | |||
delete-after: True | |||
changes: | |||
- rscadd: "Added grenades for everyone." | |||
- rscdel: "Removed everyone's brains." | |||
=== Maintainer Changelogs === | === Maintainer Changelogs === | ||