You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/changelogs.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ This guide covers why changelogs are important, what they look like, how to add
6
6
7
7
## Guide
8
8
9
-
### Summary
9
+
### tl;dr
10
10
11
11
- 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`.
12
12
- 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.
35
35
36
36
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.
37
37
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
-
50
38
### Format & structure
51
39
52
40
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
161
149
- Removed options
162
150
- Fixes for bugs, security issues, etc.
163
151
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
+
164
164
## Best practices
165
165
166
166
### List unreleased changes separately from released changes
0 commit comments