Skip to content
Snippets Groups Projects
Unverified Commit 8bde3a6f authored by mergify[bot]'s avatar mergify[bot] Committed by GitHub
Browse files

Merge pull request #9946 from cabalism/docs/user-visible-is

Define a user-visible change
parents 41c140a4 c0ba5531
No related branches found
No related tags found
No related merge requests found
......@@ -290,9 +290,15 @@ issues) when appropriate.
Changelog
---------
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.
Anything that changes `cabal-install:exe:cabal` or changes exports from library
modules or changes behaviour of functions exported from packages published to
hackage is a <a id="user-visible-change">user-visible change</a>. Raising the
lower bound on `base` is most definitely a user-visible change because it
excludes versions of GHC from being able to build these packages.
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.
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.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment