diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index cba9c4646f..acced509cb 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,17 +1,26 @@ + + ## Description +If the PR solves an issue then provide a link to that issue using format `Closes #` or `Fixes #` (replace`` with issue number) +--> ## Checklist - -- [ ] 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 #` or `Fixes #` (replace`` 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/)