Skip to content

Commit 07870f4

Browse files
authored
Optionally use semicolon as separator (#19)
1 parent cef8174 commit 07870f4

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -249,14 +249,26 @@ The latter form should only be used to reference issues in external repositories
249249

250250
#### 2.4.3. Authors
251251

252-
Author names must be written after references, wrapped in parentheses and separated by commas. If the project only has one contributor, author names can be omitted. For changes authored by bots, the author listed in the changelog should be the person that merged the relevant Pull Request(s).
253-
254-
Example:
252+
Author names must be written after references, wrapped in parentheses and separated by commas. Example:
255253

256254
```md
257255
- Fix infinite loop ([#194](https://github.com/owner/name/issues/194)) (Alice Meerkat)
258256
```
259257

258+
With multiple authors it would be (links omitted for brevity):
259+
260+
```md
261+
- Fix infinite loop (#194) (Alice Meerkat, Milly Moose)
262+
```
263+
264+
Alternatively, separate the references and authors by a semicolon, which can make lists of lists because a semicolon is a stronger punctuation mark than a comma. For example:
265+
266+
```md
267+
- Fix infinite loop (#194, #195; Alice Meerkat, Milly Moose)
268+
```
269+
270+
If the project only has one contributor, author names can be omitted. For changes authored by bots, the author listed in the changelog should be the person that merged the relevant Pull Request(s).
271+
260272
There are no rules for whether to use the author's full name, username, or other. Common Changelog does recommend using the author's own preferred name, for which git is the most readily available source of truth.
261273

262274
#### 2.4.4. Prefixes

0 commit comments

Comments
 (0)