Skip to content

Commit

Permalink
update changelog.d format and Matrix link
Browse files Browse the repository at this point in the history
`changelog-d` was changed to make `packages` a list, so reflect
this in the example. Also remove the "omit if it's an overarching
change" part: we must list all packages if we want it to show up
when generating release changelogs.

While I was there, I updated the Matrix channel reference because
it was still reflecting the EMS Libera bridge.
  • Loading branch information
geekosaur committed Sep 27, 2024
1 parent c53a03a commit 888cf86
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -344,14 +344,15 @@ description: {
}
```
(Note: if you choose to use `changelog-d`'s Markdown format, `packages` must be a bracketed list.)

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

| Field | Description |
| ----- | ----------- |
| `synopsis` | Brief description of the change. Often just the pr title. |
| `description` | Longer description, with a list of sub-changes. Not needed for small/atomic changes. |
| `packages` | Packages affected by the change (`cabal-install`, `Cabal`...). Omit if it's an overarching or non-package change. |
| `packages` | Packages affected by the change (`cabal-install`, `Cabal`...). Omit if it's a non-package change. |
| `prs` | Space-separated hash-prefixed pull request numbers containing the change (usually just one). |
| `issues` | Space-separated hash-prefixed issue numbers that the change fixes/closes/affects. |
| `significance` | Set to `significant` if the change is significant, that is if it warrants being put near the top of the changelog. |
Expand All @@ -377,7 +378,7 @@ There are a few main venues of communication:

* Many developers idle on `#hackage` on [`irc.libera.chat`](https://libera.chat). The `#ghc` channel is also a decently good bet.
* You can join the channel using a web client, even anonymously: https://web.libera.chat/#hackage
* Alternatively you can join it using [matrix](https://matrix.org/): https://matrix.to/#/#hackage:libera.chat
* Alternatively you can join it using [matrix](https://matrix.org/): https://matrix.to/#/#hackage:matrix.org

Releases
--------
Expand Down

0 comments on commit 888cf86

Please sign in to comment.