.gitignore added
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / stylelint / docs / developer-guide / pull-requests.md
1 # Reviewing pull requests
2
3 Rules of thumb:
4
5 -   Use the [GitHub review system](https://help.github.com/articles/about-pull-request-reviews/).
6 -   Review against the [Developer Guide criteria](rules.md).
7 -   Assign one or more of the appropriate [`PR: needs *` labels](https://github.com/stylelint/stylelint/labels) when requesting a change.
8 -   Resolve conficts by [rebasing](https://www.atlassian.com/git/tutorials/rewriting-history/git-rebase), rather than merging the target branch into the pull request branch.
9
10 Merge process:
11
12 1.  Make sure the pull request has the correct number of approvals:
13     -   For simple documentation fixes: one;
14     -   For all other pull requests: two.
15 2.  "Squash and merge" commits, ensuring the resulting commit message is consistently formatted:
16     -   Sentence case.
17     -   Descriptive.
18 3.  Update the [CHANGELOG](https://github.com/stylelint/stylelint/blob/master/CHANGELOG.md) directly via the [GitHub website](https://github.com/stylelint/stylelint/edit/master/CHANGELOG.md) for all merged PRs (except documentation changes):
19     -   Create a `# Head` heading if one does not exist already.
20     -   Prefix the item with either: Removed, Changed, Deprecated, Added, or Fixed.
21     -   Order the item within the group by the widest reaching first to the smallest, and then alphabetically by rule name.
22     -   Suffix the item with the relevant pull request number, using the complete GitHub URL so that it works on [the website](https://stylelint.io/CHANGELOG/).
23     -   If applicable, lead the item with the name of rule e.g. "Fixed: `unit-blacklist` false positives for SCSS nested properties".
24 4.  Lastly, post the item as a comment to the pull request.