From 29ea42bd9d3fee12cba0bfd6dc78427d19d44754 Mon Sep 17 00:00:00 2001 From: ShadowCommander <10494922+ShadowCommander@users.noreply.github.com> Date: Wed, 14 Aug 2024 17:08:17 -0700 Subject: [PATCH] Add admin changelog PR text format to pull-request-guidelines --- .../codebase-info/pull-request-guidelines.md | 26 +++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/src/en/general-development/codebase-info/pull-request-guidelines.md b/src/en/general-development/codebase-info/pull-request-guidelines.md index 2b7e2ae3c..690cc85eb 100644 --- a/src/en/general-development/codebase-info/pull-request-guidelines.md +++ b/src/en/general-development/codebase-info/pull-request-guidelines.md @@ -85,6 +85,32 @@ Each entry is either an `add`, `remove`, `tweak`, or `fix`. There can be multipl Maintainers may, at their discretion, add, modify, or remove a change log entry that you suggest. +#### Admin changelog + +Putting `ADMIN` or `ADMIN:` in the changelog will place all changelogs below it into the admin changelog instead of the standard player changelog. + +``` +:cl: +ADMIN +- add: Added fun! +- remove: Removed fun! +- tweak: Changed fun! +- fix: Fixed fun! +``` +or +``` +:cl: +- add: Added fun! +- remove: Removed fun! +- tweak: Changed fun! +- fix: Fixed fun! +ADMIN +- add: Added fun! +- remove: Removed fun! +- tweak: Changed fun! +- fix: Fixed fun! +``` + ## Writing An Effective Changelog The Changelog is for *players* to be aware of new features and changes that could affect how they play the game. It is *not* designed for maintainers, admins, or server operators (these should be in the PR description).