Document that non-spec changes should get an 'internal' changelog entry #1342
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
anoadragon453
commented
Nov 15, 2022
| ``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: |
There was a problem hiding this comment.
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".
There was a problem hiding this comment.
Hopefully it should be relatively self-explanatory, although I'm surprised there aren't more bugfixes.
dbkr
approved these changes
Nov 16, 2022
| ``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: |
There was a problem hiding this comment.
Hopefully it should be relatively self-explanatory, although I'm surprised there aren't more bugfixes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates the contributing documentation to mention that we now support "internal" changelog entries after #1194.
Preview: https://pr1342--matrix-spec-previews.netlify.app