Skip to content

Commit

Permalink
patchups to changelog.d file descriptions
Browse files Browse the repository at this point in the history
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. ☹
  • Loading branch information
geekosaur committed Oct 3, 2024
1 parent d215dc3 commit ba1b29a
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -350,22 +350,27 @@ description: {

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

```markdown
---
synopsis: Add feature xyz
packages: [cabal-install]
prs: #0000
issues: #0000 #0000
prs: 0000
issues: [0000, 0000]
significance: significant
---

- Detail number 1
- Detail number 2

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

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

Expand Down

0 comments on commit ba1b29a

Please sign in to comment.