Skip to content

Commit 8bde3a6

Browse files
authoredMay 1, 2024··
Merge pull request #9946 from cabalism/docs/user-visible-is
Define a user-visible change
2 parents 41c140a + c0ba553 commit 8bde3a6

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed
 

‎CONTRIBUTING.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -290,9 +290,15 @@ issues) when appropriate.
290290
Changelog
291291
---------
292292
293-
When opening a pull request with a user-visible change, you should write one changelog entry
294-
(or more in case of multiple independent changes) — the information will end up in
295-
our release notes.
293+
Anything that changes `cabal-install:exe:cabal` or changes exports from library
294+
modules or changes behaviour of functions exported from packages published to
295+
hackage is a <a id="user-visible-change">user-visible change</a>. Raising the
296+
lower bound on `base` is most definitely a user-visible change because it
297+
excludes versions of GHC from being able to build these packages.
298+
299+
When opening a pull request with a user-visible change, you should write one
300+
changelog entry (or more in case of multiple independent changes) — the
301+
information will end up in our release notes.
296302
297303
Changelogs for the next release are stored in the `changelog.d` directory.
298304
The files follow a simple key-value format similar to the one for `.cabal` files.

0 commit comments

Comments
 (0)
Please sign in to comment.