Skip to content

Commit 1ca06bf

Browse files
nikosdouvlisnikosdouvlis
committed
chore(repo): Update CONTRIBUTING.md
1 parent 5fce80b commit 1ca06bf

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

‎docs/CONTRIBUTING.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,26 @@ A changeset is a piece of information about changes made in a branch or commit.
9292
- What version we are releasing packages at (using a semver bump type)
9393
- A changelog entry for the released packages
9494

95+
The first of the changeset description is used as the changelog entry title, the rest of the description is used as the changelog entry body. For example:
96+
97+
```markdown
98+
---
99+
'@clerk/nextjs': minor
100+
---
101+
102+
Introduce `debug` prop in `authMiddleware`
103+
A new `debug` prop has been added to the `authMiddleware` function. When set to `true`, the middleware will log the request and response to the console.
104+
```
105+
106+
Will generate the following changelog entry:
107+
108+
```markdown
109+
## Minor Changes
110+
111+
- Introduce `debug` prop in `authMiddleware` (#123) by @johndoe
112+
A new `debug` prop has been added to the `authMiddleware` function. When set to `true`, the middleware will log the request and response to the console.
113+
```
114+
95115
Tips:
96116

97117
- Changesets are just markdown files. Feel free to add as much markdown as you want to better describe the change.

0 commit comments

Comments
 (0)