Skip to content

Commit

Permalink
CONTRIBUTING.md: more description of changelogs (#9011)
Browse files Browse the repository at this point in the history
* CONTRIBUTING.md: more description of changelogs

In particular, mention that Markdown is allowed.

* phrasing better

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
  • Loading branch information
ulysses4ever and mergify[bot] authored Jun 14, 2023
1 parent 90b5e95 commit c9aee94
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,13 +242,16 @@ and concatenate the commit messages of the commits before merging.
Changelog
---------

When opening a pull request, you should write a changelog entry
(or more in case of multiple independent changes).
This is done by adding files in the `changelog.d` directory.
When opening a pull request with a user-visible change, you should write one changelog entry
(or more in case of multiple independent changes) — the information will end up in
our release notes.

The files follow a simple key-value format similar to the one for .cabal files.
Changelogs for the next release are stored in the `changelog.d` directory.
The files follow a simple key-value format similar to the one for `.cabal` files.
Free-form text fields (`synopsis` and `description`) allow Markdown markup — please,
use markup to make our release notes more readable.

Here's an exhaustive example:
Here's an example:

```cabal
synopsis: Add feature xyz
Expand Down Expand Up @@ -282,7 +285,7 @@ You can find a large number of real-world examples of changelog files
At release time, the entries will be merged with
[this tool](https://github.com/fgaz/changelog-d).

In addition, if you're changing the .cabal file format specification you should
In addition, if you're changing the `.cabal` file format specification you should
add an entry in `doc/file-format-changelog.rst`.

Communicating
Expand Down

0 comments on commit c9aee94

Please sign in to comment.