Skip to content

Commit 9c1b3ed

Browse files
committed
Update doc
1 parent 8565e7b commit 9c1b3ed

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

docs/changelogs.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This guide covers why changelogs are important, what they look like, how to add
66

77
## Guide
88

9-
### Summary
9+
### tl;dr
1010

1111
- Every MetaMask app, API, library, or tool ("product") that is publicly available and released in versions should have a "Keep a Changelog"-formatted changelog file called `CHANGELOG.md`.
1212
- Changelogs should be tailored for its primary audience, the people that use the product ("users").
@@ -35,18 +35,6 @@ Changelogs are not a list of commits to a codebase.
3535

3636
Some opensource projects copy and paste the direct output of `git log` for their changelogs. But commit messages can be cryptic, and they often contain implementation details which may be useful for engineers but are irrelevant for end users.
3737

38-
## Adding a changelog
39-
40-
If you want to add a changelog to a new or existing repo:
41-
42-
1. Ensure that you have a JavaScript package manager installed, and you've added a `package.json` to the root.
43-
2. Add `@metamask/auto-changelog` to `devDependencies`.
44-
3. Add a `lint:changelog` package script which runs `auto-changelog validate`.
45-
4. Configure CI to reject PRs and pushes to `main` if `lint:changelog` does not pass.
46-
5. Generate an initial changelog by running `yarn auto-changelog init` or `npm auto-changelog init`.
47-
48-
See the [module template](https://github.com/MetaMask/metamask-module-template) for an example of a repo that has an existing changelog.
49-
5038
### Format & structure
5139

5240
All changelogs should be written in a format based on the ["Keep a Changelog"](https://keepachangelog.com/) specification. This format is enforced by [`@metamask/auto-changelog`](https://github.com/MetaMask/auto-changelog).
@@ -161,6 +149,18 @@ Yes, public actions and workflows should have changelogs too! They should at lea
161149
- Removed options
162150
- Fixes for bugs, security issues, etc.
163151

152+
## Adding a changelog
153+
154+
If you want to add a changelog to a new or existing repo:
155+
156+
1. Ensure that you have a JavaScript package manager installed, and you've added a `package.json` to the root.
157+
2. Add `@metamask/auto-changelog` to `devDependencies`.
158+
3. Add a `lint:changelog` package script which runs `auto-changelog validate`.
159+
4. Configure CI to reject PRs and pushes to `main` if `lint:changelog` does not pass.
160+
5. Generate an initial changelog by running `yarn auto-changelog init` or `npm auto-changelog init`.
161+
162+
See the [module template](https://github.com/MetaMask/metamask-module-template) for an example of a repo that has an existing changelog.
163+
164164
## Best practices
165165

166166
### List unreleased changes separately from released changes

0 commit comments

Comments
 (0)