-
Notifications
You must be signed in to change notification settings - Fork 507
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update pull request template (#2092)
Closes #2089
- Loading branch information
1 parent
9754f5f
commit ef4afbe
Showing
1 changed file
with
17 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,26 @@ | ||
| <!-- Thanks for opening a new PR! | ||
| Before you click submit, please consult the Checklist below. Note, that you still can add new commits to your branch before submitting the PR. | ||
| --> | ||
|
|
||
| ## Description | ||
|
|
||
| <!--Describe what was done and why (mandatory). The description should help the reviewer to understand what the PR is about and which decisions have been made. | ||
| If the PR solves an issue then provide a link to that issue. --> | ||
| If the PR solves an issue then provide a link to that issue using format `Closes #<xxx>` or `Fixes #<xxx>` (replace`<xxx>` with issue number) | ||
| --> | ||
|
|
||
| ## Checklist | ||
|
|
||
| <!-- Following checklist may be skipped in some cases --> | ||
| - [ ] PR description added | ||
| - [ ] tests are added | ||
| - [ ] KtLint has been applied on source code itself and violations are fixed | ||
| - [ ] [documentation](https://pinterest.github.io/ktlint/) is updated | ||
| Before submitting the PR, please check following (checks which are not relevant may be ignored): | ||
| - [ ] Commit message are well written. In addition to a short title, the commit message also explain why a change is made. | ||
| - [ ] At least one commit message contains a reference `Closes #<xxx>` or `Fixes #<xxx>` (replace`<xxx>` with issue number) | ||
| - [ ] Tests are added | ||
| - [ ] KtLint format has been applied on source code itself and violations are fixed | ||
| - [ ] `CHANGELOG.md` is updated | ||
| - [ ] PR description added | ||
|
|
||
| In case of adding a new rule: | ||
| - [ ] Rule is added to [rules documentation](https://pinterest.github.io/ktlint/rules/standard/) | ||
| [Documentation](https://pinterest.github.io/ktlint/) is updated. See [difference between snapshot and release documentation](https://github.com/pinterest/ktlint/tree/master/documentation) | ||
| - [ ] [Snapshot documentation](https://github.com/pinterest/ktlint/tree/master/documentation/snapshot) in case documentation is to be released together with a code change | ||
| - [ ] [Release documentation](https://github.com/pinterest/ktlint/tree/master/documentation/release-latest) in case documentation is related to a released version of ktlint and has to be published as soon as the change is merged to master | ||
| - [ ] In case of adding a new rule, it needs to be added to [experimental rules documentation](https://pinterest.github.io/ktlint/latest/rules/experimental/) |