From c7310ec802c16249be39008588a060bf7fd67de6 Mon Sep 17 00:00:00 2001 From: Travis Nielsen Date: Thu, 9 Apr 2020 00:11:16 -0600 Subject: [PATCH] git: clarify CI flags in PR template The commitlint bot is rarely understood and flags to skip the CI are rarely used by new contributors. This update to the PR template aims to make these options more discoverable to newer members of the community Signed-off-by: Travis Nielsen --- .github/PULL_REQUEST_TEMPLATE.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7fbae61fa..6ac91ff24 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -9,6 +9,9 @@ Resolves # **Checklist:** +- [ ] **CommitLint Bot**: Commit titles and messages follow guidelines in the [developer guide](https://rook.io/docs/rook/master/development-flow.html#commit-structure). +- [ ] **Skip Tests for Docs**: Add the flag for skipping the build if this is only a documentation change. See [here](https://github.com/rook/rook/blob/master/INSTALL.md#skip-ci) for the flag. +- [ ] **Skip Unrelated Tests**: Add a flag to run tests for a specific storage provider. See [test options](https://github.com/rook/rook/blob/master/INSTALL.md#test-storage-provider). - [ ] Reviewed the developer guide on [Submitting a Pull Request](https://rook.io/docs/rook/master/development-flow.html#submitting-a-pull-request) - [ ] Documentation has been updated, if necessary. - [ ] Unit tests have been added, if necessary. @@ -16,5 +19,3 @@ Resolves # - [ ] Pending release notes updated with breaking and/or notable changes, if necessary. - [ ] Upgrade from previous release is tested and upgrade user guide is updated, if necessary. - [ ] Code generation (`make codegen`) has been run to update object specifications, if necessary. -- [ ] Comments have been added or updated based on the standards set in [CONTRIBUTING.md](https://github.com/rook/rook/blob/master/CONTRIBUTING.md#comments) -- [ ] Add the flag for skipping the CI if this PR does not require a build. See [here](https://github.com/rook/rook/blob/master/INSTALL.md#skip-ci) for more details.