Skip to content

Commit

Permalink
impl: require a changelog entry for content changes (#958)
Browse files Browse the repository at this point in the history
As discussed in the conversation for PR #892, specifically:
#892 (comment)
we should treat the "What's New" page as a Changelog and require
that all content changes to the specification have a corresponding
entry. Update "Contributing to SLSA" to capture this requirement.

Signed-off-by: Joshua Lock <joshuagloe@gmail.com>
  • Loading branch information
joshuagl authored Aug 24, 2023
1 parent 9ee63a3 commit f7008f0
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ maintainer will update if needed. See [review and approval] for the meaning of

| Type | Meaning | Waiting period | # Approvers |
|---|---|---|---|
| `content` | A change to the meaning of the specification. | 72h | 3 |
| `content` | A change to the meaning of the specification. Must include a [changelog entry]. | 72h | 3 |
| `editorial` | A clarification to the specification that does not change its meaning, beyond a simple `fix`. | 24h | 2 |
| `nonspec` | A change to a non-specification, non-blog page, beyond a simple `fix`. | 24h | 2 |
| `blog` | A new or updated blog post. (Do not mix with categories above.) | 24h | 2 |
Expand All @@ -117,6 +117,15 @@ always requires one reviewer, even if the author has write access.

[squash and merge]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-commits

### Changelog entry

[changelog entry]: #changelog-entry

All `content` changes to the specification should also include a brief
description of the change in the adjacent `whats-new.md` file, in order to help
readers of an updated version of the specification to more easily identify
changes.

### Review and approval

[review and approval]: #review-and-approval
Expand Down

0 comments on commit f7008f0

Please sign in to comment.