Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document that non-spec changes should get an 'internal' changelog entry #1342

Merged
merged 2 commits into from Nov 16, 2022
Merged

Document that non-spec changes should get an 'internal' changelog entry #1342

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a756610
Document that non-spec changes should get an 'internal' changelog entry
anoadragon453 Nov 15, 2022
0ee59be
changelog
anoadragon453 Nov 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 6 additions & 5 deletions CONTRIBUTING.rst
View file
Open in desktop
Expand Up @@ -76,8 +76,12 @@ All API specifications require a changelog entry. Adding to the changelog can on
be done after you've opened your pull request, so be sure to do that first.

The changelog is managed by `Towncrier <https://github.com/twisted/towncrier>`_ in the
form of "news fragments". The news fragments for the client-server API are stored
under ``changelogs/client_server/newsfragments``.
form of "news fragments". Depending on which API you changed, an entry should be added to
each relevant API's ``newsfragments`` directory. A directory exists for each API under
``changelogs/``. For instance, news fragments for the client-server API are stored
under ``changelogs/client_server/newsfragments``. Any changes to the repository that do
not affect the spec content itself, such as changes to the build script, formatting, CSS,
etc. should be documented under ``changelogs/internal/newsfragments``.

To create a changelog entry, create a file named in the format ``prNumber.type`` in
the ``newsfragments`` directory. The ``type`` can be one of the following:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to provide any additional guidance on what types are generally used for internal changes? So far I only see "clarification" and "feature".

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hopefully it should be relatively self-explanatory, although I'm surprised there aren't more bugfixes.

Expand All @@ -99,9 +103,6 @@ All news fragments must have a brief summary explaining the change in the
contents of the file. The summary must end in a full stop to be in line with
the style guide and formatting must be done using Markdown.

Changes that do not change the spec, such as changes to the build script, formatting,
CSS, etc should not get a news fragment.

Sign off
--------

Expand Down
1 change: 1 addition & 0 deletions changelogs/internal/newsfragments/1342.clarification
View file
Open in desktop
@@ -0,0 +1 @@
Update CONTRIBUTING.md to mention that non-content changes to this repo should have an "internal" changelog entry.