Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Define a user-visible change #9946

Merged
merged 2 commits into from
May 1, 2024
Merged

Define a user-visible change #9946

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fbe25f8
Define a user-visible change
philderbeast Apr 28, 2024
c0ba553
Include bumping base as user-visible
philderbeast Apr 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down