Skip to content

Commit d5c340a

Browse files
committed
Update
1 parent 9c1b3ed commit d5c340a

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

docs/changelogs.md

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

1818
Why do products needs changelogs?
1919

20-
A changelog answers the following questions that your users will probably have when a new release of your product is issued:
20+
A changelog answers the following questions that users of your project will probably have when you make a new release:
2121

2222
- What can I use now that I couldn't use before?
2323
- What changed about something that I may use now?
@@ -29,7 +29,7 @@ In addition, a changelog also answers the following questions that you will prob
2929
- In which version was this change or fix introduced?
3030
- Where was the code commit or pull request that introduced the change?
3131

32-
## What changelogs are not
32+
### What changelogs are not
3333

3434
Changelogs are not a list of commits to a codebase.
3535

@@ -104,23 +104,23 @@ Different kinds of products are used differently, and in order to be useful, the
104104

105105
<!--Changes that are invisible to users (refactors, changes to CI or build tools, etc.) should be omitted.-->
106106

107-
### UI-based products (apps, websites, graphical tools, etc.)
107+
#### UI-based products (apps, websites, graphical tools, etc.)
108108

109109
Changelogs for these products should at least mention:
110110

111111
- New features (e.g., a new tab on the home page, a new setting, etc.)
112112
- Changes to the UI, particularly those that may interrupt a standard workflow (moving a button or dropdown to another screen, reworking part of a screen, etc.)
113113
- Fixes for bugs, security issues, etc.
114114

115-
### CLIs
115+
#### CLIs
116116

117117
Changelogs for command-line tools should at least mention:
118118

119119
- New commands, options, or workflows
120120
- Changes to existing commands, options, or workflows
121121
- Fixes for bugs, security issues, etc
122122

123-
### HTTP APIs
123+
#### HTTP APIs
124124

125125
Changelogs for APIs accessible via HTTP should at least mention:
126126

@@ -130,7 +130,7 @@ Changelogs for APIs accessible via HTTP should at least mention:
130130
- Removed endpoints/routes
131131
- Fixes for bugs, security issues, etc.
132132

133-
### Libraries
133+
#### Libraries
134134

135135
Changelogs for libraries should at least mention:
136136

@@ -140,7 +140,7 @@ Changelogs for libraries should at least mention:
140140
- Removed exports or symbols in existing exports
141141
- Fixes for bugs, security issues, etc.
142142

143-
### GitHub actions/workflows
143+
#### GitHub actions/workflows
144144

145145
Yes, public actions and workflows should have changelogs too! They should at least mention:
146146

@@ -149,7 +149,7 @@ Yes, public actions and workflows should have changelogs too! They should at lea
149149
- Removed options
150150
- Fixes for bugs, security issues, etc.
151151

152-
## Adding a changelog
152+
### Adding a changelog
153153

154154
If you want to add a changelog to a new or existing repo:
155155

0 commit comments

Comments
 (0)