Skip to content

Commit 890a763

Browse files
authored
Merge pull request #10521 from ffaf1/significant-change
Add “Significant change” guideline
2 parents 5aaf8ea + a718eb3 commit 890a763

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

.github/pull_request_template.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Include the following checklist in your PR:
88

99
* [ ] Patches conform to the [coding conventions](https://github.com/haskell/cabal/blob/master/CONTRIBUTING.md#other-conventions).
1010
* [ ] Any changes that could be relevant to users [have been recorded in the changelog](https://github.com/haskell/cabal/blob/master/CONTRIBUTING.md#changelog).
11+
* [ ] [Is the change significant?](https://github.com/haskell/cabal/blob/master/CONTRIBUTING.md#is-my-change-significant) If so, remember to add `significance: significant` in the changelog file.
1112
* [ ] The documentation has been updated, if necessary.
1213
* [ ] [Manual QA notes](https://github.com/haskell/cabal/blob/master/CONTRIBUTING.md#qa-notes) have been included.
1314
* [ ] Tests have been added. (*Ask for help if you don’t know how to write them! Ask for an exemption if tests are too complex for too little coverage!*)

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -439,6 +439,18 @@ At release time, the entries will be merged with
439439
In addition, if you're changing the `.cabal` file format specification you should
440440
add an entry in `doc/file-format-changelog.rst`.
441441

442+
### Is my change `significant`?
443+
444+
Use your best judgement and if unsure ask other maintainers. If your PR fixes
445+
a specific ticket, how busy was the discussion there? A new command or option
446+
most likely warrants a `significance: significant` tag, same with command
447+
line changes that disrupts the workflow of many users or an API change
448+
that requires substantial time to integrate in a program.
449+
450+
Put yourself in the shoes of the user: would you appreciate seeing this
451+
change highlighted in the announcement post or release notes overview? If
452+
so, add `significance: significant`.
453+
442454
## Communicating
443455

444456
There are a few main venues of communication:

0 commit comments

Comments
 (0)