- Create a file in the
news/
directory called<type>-<pr-id>.md
, where<type>
is either:feature
: New functionality.bugfix
: Fix to a reported bug.packaging
: Packaging related change.developer-note
: Changes, that are only interesting to developers. (internal API change, etc...)other
: Other important, but not categorized change. You can query the next PR ID with thenext_pr_id.py
script, but it could be a good practice to add the commit, containing the news entry, after you have opened your PR, as you will know your PR ID then. Multiple news entries can be created for a single PR, if necessary. The file name is numbered in that case:<type>-<pr-id>-<n>.md
.
- Fill it with the summary of the PR.
- You can use any markdown formatting.
- Please make sure, that there are no lines longer than 120 characters.
- Make it 2-3 sentences at most.
- Start the entry with the affected modules then a colon. For example: "
network-dest
: Added..."
- Commit it with the message:
news: <type>-<pr-id>
, for example: "news: bugfix-1234"
- Run
news/create-newsfile.py
(python3
required) - Fill the
Highlights
section in the newly createdNEWS.md
file.
Note, the script uses the VERSION
file, so it is necessary bump the version there, before running the script.