Skip to content

Commit a7eacfa

Browse files
geekosaurerikd
authored andcommitted
patchups to changelog.d file descriptions
Bug copied from `changelog-d`'s `README.md`. A good example of why copying it into `CONTRIBUTING.md` because we can't reference it from there is a bad idea. ☹
1 parent c3a271c commit a7eacfa

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -350,22 +350,27 @@ description: {
350350

351351
Changelogs may also be written in "markdown-frontmatter" format. This is useful if your
352352
description contains braces, which must be escaped with backslashes in `.cabal` file
353-
format.
353+
format. The front matter is in YAML syntax, not `.cabal` file syntax, and the file
354+
_must_ begin with a line containing only hyphens.
354355

355356
```markdown
356357
---
357358
synopsis: Add feature xyz
358359
packages: [cabal-install]
359-
prs: #0000
360-
issues: #0000 #0000
360+
prs: 0000
361+
issues: [0000, 0000]
361362
significance: significant
362363
---
363364

364365
- Detail number 1
365366
- Detail number 2
366367

367368
```
368-
The package list must be enclosed in square brackets and comma-separated, but this isn't needed for `prs` or `issues`.
369+
The package list must be enclosed in square brackets and comma-separated, but this
370+
isn't needed for `prs` or `issues`; those are free-form and any YAML syntax will
371+
be accepted. Note that the number signs on PR and issue numbers are required in
372+
`.cabal` file syntax, but won't work in markdown-frontmatter syntax because they
373+
signify comments in YAML.
369374

370375
Only the `synopsis` and `prs` fields are required, but you should also set the others where applicable.
371376

0 commit comments

Comments
 (0)