Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add admin changelog PR text format to pull-request-guidelines #282

Merged
merged 3 commits into from
Aug 15, 2024
Merged

Add admin changelog PR text format to pull-request-guidelines #282

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
29ea42b
Add admin changelog PR text format to pull-request-guidelines
ShadowCommander Aug 15, 2024
2e86bf7
Update pull-request-guidelines.md
ShadowCommander Aug 15, 2024
59e5d70
Add note for invalid category
ShadowCommander Aug 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions src/en/general-development/codebase-info/pull-request-guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,34 @@ 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:` in the changelog will place all changelogs below it into the admin changelog category instead of the main changelog category.

Note: The category is case-insensitive, but if it is not alphabetical ending with a colon, it will fail parsing the category and will fall back to placing the changelogs in the previous category or the main changelog category.

```
: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).

Expand Down
Loading