vasilito
ff4ff35918
Red Bear OS is a full fork. All sources must be available from git clone with zero network access. Removed gitignore rules that excluded fetched source trees under recipes/*/source/, local/recipes/kde/*/source/, local/recipes/qt/*/source/, and vendor source trees. Build artifacts (target/, build/, source.tar, *.o, *.so) remain excluded. 127291 files added — kernel, relibc, base, bootloader, pkgar, all KDE/Qt frameworks, mesa, wayland, DRM drivers, and every other recipe source.
1.7 KiB
1.7 KiB
Fragments for the changelog
This directory contains fragments for the future NEWS file.
Introduction
We use towncrier to produce useful, summarized news files.
There are 3 sections types:
- API:
changes/api - Tools:
changes/tools - Build System:
changes/build
There are 3 news fragments types:
- Breaking changes:
.breaking - New:
.feature - Fixes:
.bugfix
Adding a fragment
Add a short description of the change in a file changes/SECTION/ID.FRAGMENT.md,
where:
SECTIONandFRAGMENTvalues are described in the previous section.IDis the corresponding issue identifier on Github, if relevant. If there is no such issue, thenIDshould start with+and some identifier that make the file unique in the directory.
Examples:
- A bug fix for the issue #463 is an API change, so the corresponding file
should be named
changes/api/463.bugfix.md. - A new feature for tools like #448 corresponds to e.g.
changes/tools/+add-verbose-opt.feature.md.
Guidelines for the fragment files:
- Use the Markdown markup.
- Use past tense, e.g. “Fixed a segfault”.
- Look at the previous releases NEWS file for further examples.
Build the changelog
Install towncrier from Pypi:
python3 -m pip install towncrier
Then build the changelog:
# Only check the result. Useful after adding a new fragment.
towncrier build --draft --version 1.8.0
# Write the changelog & delete the news fragments
towncrier build --yes --version 1.8.0