Skip to content

Commit

Permalink
Document that non-spec changes should get an 'internal' changelog ent…
Browse files Browse the repository at this point in the history
…ry (#1342)
  • Loading branch information
anoadragon453 committed Nov 16, 2022
1 parent f0246a5 commit b5005e6
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
11 changes: 6 additions & 5 deletions CONTRIBUTING.rst
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:
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
@@ -0,0 +1 @@
Update CONTRIBUTING.md to mention that non-content changes to this repo should have an "internal" changelog entry.

0 comments on commit b5005e6

Please sign in to comment.