nucypher/newsfragments
derekpierre b21daca7f9
Add dev newsfragment for #3519.
2024-07-04 14:26:59 -04:00
..
.gitignore Initial setup for towncrier 2020-05-28 11:59:08 -07:00
3496.feature.rst newsfrag for PR #3496 2024-05-30 11:03:43 +02:00
3498.dev.rst Add dev newsfragment for #3498. 2024-05-13 09:30:09 -04:00
3499.dev.rst Add dev newsfragment for #3499. 2024-05-13 14:43:36 -04:00
3502.feature.rst Add newsfragment for #3502. 2024-05-16 13:11:05 -04:00
3507.dev.rst Add dev newsfragment for #3507. 2024-05-28 08:09:12 -04:00
3508.feature.rst Allow any valid user authentication scheme for `:userAddress` context variable processing. 2024-05-29 09:46:37 -04:00
3509.dev.rst Add dev newsfragment for #3509. 2024-05-29 08:56:25 -04:00
3510.dev.rst Add dev newsfragment for #3510. 2024-06-06 15:58:01 -04:00
3513.feature.rst Add newsfragment for #3513. 2024-06-21 12:38:09 -04:00
3519.dev.rst Add dev newsfragment for #3519. 2024-07-04 14:26:59 -04:00
README.md Dev newsfragments will show up in release notes but under its own section (off to the side). 2022-11-17 09:29:45 -05:00
validate_files.py Allow for *.dev.rst newsfragments for dev-specific work, which allows for the release note gh action to pass without including information (pr/issue number) in the release notes. 2022-11-16 14:07:38 -05:00

README.md

This directory collects "newsfragments": short files that each contain a snippet of ReST-formatted text that will be added to the next release notes. This should be a description of aspects of the change (if any) that are relevant to users. It contrasts with the commit message and PR description, which are descriptions of the change relevant to people working on the code itself.

The pull request (PR) number should be included in the newsfragment file name. Each newsfragment file should be named <PR_NUMBER>.<TYPE>.rst, where <TYPE> is one of:

  • feature - features
  • bugfix - bugfixes
  • doc - documentation
  • removal - deprecations and removals
  • misc - other
  • dev - internal development tasks

For example: 123.feature.rst, 456.bugfix.rst, 789.doc.rst.

There can be multiple newsfragment files of different types for the same PR e.g. 123.feature.rst and 123.removal.rst.

Along with the required PR newsfragment file (enforced by a GitHub Action), additional newsfragment files for issues linked to the PR can optionally be included by following the same naming convention above, and using <ISSUE_NUMBER> instead of <PR_NUMBER>.

Note that the towncrier tool will automatically reflow your text, so don't try to do any fancy formatting. Run towncrier --draft to preview what the release notes entry will look like in the final release notes.