nucypher/newsfragments
KPrasch c302f9c2cd
Merge pull request #2548 from derekpierre/events-csv
Add --csv-file option for 'nucypher stake events' CLI to allow events to be output to CSV
2021-02-10 19:20:05 -08:00
..
.gitignore Initial setup for towncrier 2020-05-28 11:59:08 -07:00
2463.doc.rst newsfragment for #2463 2021-02-04 10:39:51 -08:00
2518.removal.rst Apply suggestions from code review #2518 2021-02-02 19:24:29 +03:00
2543.bugfix.rst Add a newsfragment for PR #2543 2021-01-28 09:27:27 -08:00
2544.feature.rst New modification of WorkLockPoolingContract - without worklock part 2021-01-30 16:27:38 +03:00
2546.misc.rst Added newsfragement for PR #2546. 2021-02-03 11:44:30 -05:00
2548.feature.rst Add newsfragment for PR #2548. 2021-02-08 20:04:41 -05:00
2550.bugfix.rst newsfragment for PR #2550 2021-02-06 20:57:36 -08:00
2551.feature.rst newsfragment for PR #2551 2021-02-07 09:43:19 -08:00
2554.doc.rst Apply suggestions from code review 2021-02-08 11:13:59 -08:00
2555.bugfix.rst Newsfragment for PR #2555 2021-02-07 11:33:33 -08:00
README.md Additional clarification about optional use of issue newsfragment files. 2020-11-03 14:49:57 -05:00
validate_files.py Add missing lisences 2020-09-08 13:08:10 -07: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. (This contrasts with the commit message and PR description, which are a description of the change as relevant to people working on the code itself.)

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

  • feature
  • bugfix
  • doc
  • misc

For example: 123.feature.rst, 456.bugfix.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 get a preview of what the release notes entry will look like in the final release notes.