0ct0pu5/wesnoth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add a directory for PR changelog entries.

Browse source
This commit is contained in:
Pentarctagon 2022-10-13 22:31:55 -05:00
parent 6b42ab39c6
commit 5334be26d3
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
changelog_entries/README.txt Normal file
View file

@ -0,0 +1,8 @@
This directory is where PR authors can add a file per PR containing the text that should be added to the main changelog.md during the release process for the next version. The format should match that of the main changelog as well as use an existing category defined there. For example, a file could contain:
```
### Terrain
* Change codes "Irs, Ias, Icr, Ior, and Icn" to "Isr, Isa, Isc, Iwo, and Iwc", respectively
```
The purpose of this is to make it easier to add changelog entries with a PR while avoiding merge conflicts in the main changelog file if someone ends up merging their PR before yours.
The contents of this directory (aside from this README file) will then be deleted after each release.