Skip to content

Commit

Permalink
Adds a Map Changelog Entry Category (tgstation#87034)
Browse files Browse the repository at this point in the history
<!-- Write **BELOW** The Headers and **ABOVE** The comments else it may
not be viewable. -->
<!-- You can view Contributing.MD for a detailed description of the pull
request process. -->

## About The Pull Request

This should hopefully cut down on mappers using the add:/fix:/del: tag
I've talked to the maptainers about this and they seem to not be
concerned about gbp in their own system, so we should be trying to push
mappers away from using add/remove/(maybe? closing issues is cool) fix
tags and such to avoid overlap.

I've intentionally not linked this to a label due to the Map Edit label
autodetecting anyway. Should be directed only at players.

This does mean less label resolution on mapping prs, not sure how I feel
about that but I didn't want to duplicate the old image
add/remove/change labels.

Requesting wider input on this and also pinging to notify.
@tgstation/commit-access @tgstation/maptainers 

## Changelog

<!-- If your PR modifies aspects of the game that can be concretely
observed by players or admins you should add a changelog. If your change
does NOT meet this description, remove this section. Be sure to properly
mark your PRs to prevent unnecessary GBP loss. You can read up on GBP
and its effects on PRs in the tgstation guides for contributors. Please
note that maintainers freely reserve the right to remove and add tags
should they deem it appropriate. You can attempt to finagle the system
all you want, but it's best to shoot for clear communication right off
the bat. -->

:cl:
map: added a map specific changelog entry
/:cl:

<!-- Both :cl:'s are required for the changelog to work! You can put
your name to the right of the first :cl: if you want to overwrite your
GitHub username as author ingame. -->
<!-- You can use multiple of the same prefix (they're only used for the
icon ingame) and delete the unneeded ones. Despite some of the tags,
changelogs should generally represent how a player might be affected by
the changes rather than a summary of the PR's contents. -->
  • Loading branch information
LemonInTheDark authored Oct 5, 2024
1 parent d7c167a commit ec7afea
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ balance: rebalanced something
fix: fixed a few things
sound: added/modified/removed audio or sound effects
image: added/modified/removed some icons or images
map: added/modified/removed map content
spellcheck: fixed a few typos
code: changed some code
refactor: refactored some code
Expand Down
1 change: 1 addition & 0 deletions tgui/packages/tgui/interfaces/Changelog.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ const icons = {
soundadd: { icon: 'tg-sound-plus', color: 'green' },
sounddel: { icon: 'tg-sound-minus', color: 'red' },
spellcheck: { icon: 'spell-check', color: 'green' },
map: { icon: 'map', color: 'green' },
tgs: { icon: 'toolbox', color: 'purple' },
tweak: { icon: 'wrench', color: 'green' },
unknown: { icon: 'info-circle', color: 'label' },
Expand Down
7 changes: 7 additions & 0 deletions tools/pull_request_hooks/changelogConfig.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,13 @@ export const CHANGELOG_ENTRIES = [
},
],

[
["map"],
{
placeholders: ["added/modified/removed map content"],
},
],

[
["spellcheck", "typo"],
{
Expand Down

0 comments on commit ec7afea

Please sign in to comment.