|
|
# Merge request conventions
|
|
|
|
|
|
This page describes GHC's conventions for handling merge requests and code review.
|
|
|
See [Contributing a Patch](Contributing-a-Patch) for a description of the merge request and code review process.
|
|
|
|
|
|
## Field meanings
|
|
|
|
... | ... | @@ -13,26 +13,8 @@ This page describes GHC's conventions for handling merge requests and code revie |
|
|
|
|
|
## Merge request checklist
|
|
|
|
|
|
See the [merge request description template](https://gitlab.haskell.org/ghc/ghc/-/blob/master/.gitlab/merge_request_templates/Default.md) for checklist of requirements for a merge request.
|
|
|
See the [merge request description template](https://gitlab.haskell.org/ghc/ghc/-/blob/master/.gitlab/merge_request_templates/Default.md) for the checklist of requirements that appears when creating a merge request.
|
|
|
|
|
|
## Review checklist
|
|
|
|
|
|
When reviewing a merge request here are a few things to check for:
|
|
|
|
|
|
* Have you followed GHC's [coding style guidelines](https://gitlab.haskell.org/ghc/ghc/-/wikis/commentary/coding-style), and especially have you added [suitable `Notes`s](https://gitlab.haskell.org/ghc/ghc/-/wikis/commentary/coding-style#2-using-notes)?
|
|
|
* Are the commits logically structure? Are their commit messages descriptive?
|
|
|
* Are ticket numbers referenced as appropriate?
|
|
|
* Is a GHC release notes entry included (e.g. `docs/users_guide/*-notes.rst`)?
|
|
|
* Have changelog entries been added to any changed packages (e.g. `libraries/*/changelog.md`)?
|
|
|
* Has a test case been added?
|
|
|
* Milestone and ~"backport needed" label set as appropriate
|
|
|
* Does the patch add a significant new user-facing feature to GHC? If so perhaps a [GHC proposal](https://github.com/ghc-proposals/ghc-proposals) is in order.
|
|
|
* Does the patch change GHC's core libraries (e.g. `base`, `template-haskell`, `ghc-prim`)? If so:
|
|
|
* Has the [core libraries committee](https://wiki.haskell.org/Core_Libraries_Committee) consented?
|
|
|
* Has the ~"user-facing" label been applied? After applying that label, has the [head.hackage job](https://gitlab.haskell.org/ghc/head.hackage/) been run to characterise the effect of the change on user code?
|
|
|
* Changelog and release notes entries are mandatory
|
|
|
* Have package versions been bumped as appropriate?
|
|
|
* Has an entry been added to the next release's migration guide?
|
|
|
|
|
|
To ensure that all interested reviewers have an opportunity to comment, please leave at least 24 hours between the time an MR is opened and assigning to @marge-bot.
|
|
|
|
|
|
The [review checklist is now here](Contributing-a-Patch#5-review-checklist). |
|
|
\ No newline at end of file |