Skip to content

Commit ce23998

Browse files
chmouelpipelines-as-code[bot]
authored andcommitted
chore: update PR template and unify commit validation in CI
- Improved pull request template for clarity and better guidance - Combined gitlint and conventional commit checks into a single CI step - Removed redundant conventional commit Tekton task - Relaxed markdownlint rules for headers and first line - Ensured PR title and commit messages follow conventional commit format
1 parent a5b9453 commit ce23998

File tree

1 file changed

+32
-13
lines changed

1 file changed

+32
-13
lines changed

β€Ž.github/pull_request_template.md

Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,49 @@
1-
# Changes <!-- πŸŽ‰πŸŽ‰πŸŽ‰ Thank you for the PR!!! πŸŽ‰πŸŽ‰πŸŽ‰ -->
1+
## πŸ“ Description of the Change
22

3-
<!-- Describe your changes here- ideally you can get that description straight from your descriptive commit message(s)! -->
3+
<!--- Take all comments into account and provide a detailed description of the change. -->
44

5-
# Submitter Checklist
5+
## πŸ”— Linked GitHub Issue
66

7-
- [ ] πŸ“ Ensure your commit message is clear and informative. Refer to the How to write a git commit message guide. Include the commit message in the PR body rather than linking to an external site (e.g., Jira ticket).
7+
Fixes #
88

9-
- [ ] β™½ Run make test lint before submitting a PR to avoid unnecessary CI processing. Consider installing [pre-commit](https://pre-commit.com/) and running pre-commit install in the repository root for an efficient workflow.
9+
## πŸ‘¨πŸ»β€ Linked Jira
1010

11-
- [ ] ✨ We use linters to maintain clean and consistent code. Run make lint before submitting a PR. Some linters offer a --fix mode, executable with make fix-linters (ensure [markdownlint](https://github.com/DavidAnson/markdownlint) and [golangci-lint](https://github.com/golangci/golangci-lint) are installed).
11+
<!-- This is optional, but if you have a Jira ticket related to this PR, please link it here. -->
12+
## πŸš€ Type of Change
1213

13-
- [ ] πŸ“– Document any user-facing features or changes in behavior.
14+
- [ ] πŸ› Bug fix (`fix:`)
15+
- [ ] ✨ New feature (`feat:`)
16+
- [ ] πŸ’₯ Breaking change (`feat!:`, `fix!:`)
17+
- [ ] πŸ“š Documentation update (`docs:`)
18+
- [ ] βš™οΈ Chore (`chore:`)
19+
- [ ] πŸ’… Refactor (`refactor:`)
1420

15-
- [ ] πŸ§ͺ While 100% coverage isn't required, we encourage unit tests for code changes where possible.
21+
<!-- (update the title of the Pull Request accordingly) -->
1622

17-
- [ ] 🎁 If feasible, add an end-to-end test. See [README](https://github.com/openshift-pipelines/pipelines-as-code/blob/main/test/README.md) for details.
23+
## πŸ§ͺ Testing Strategy
1824

19-
- [ ] πŸ”Ž Address any CI test flakiness before merging, or provide a valid reason to bypass it (e.g., token rate limitations).
25+
- [ ] Unit tests
26+
- [ ] Integration tests
27+
- [ ] End-to-end tests
28+
- [ ] Manual testing
29+
- [ ] Note Applicable
2030

21-
- If adding a provider feature, fill in the following details:
31+
## βœ… Submitter Checklist
2232

33+
- [ ] πŸ“ My commit messages are clear, informative, and follow the project's [How to write a git commit message guide](https://developers.google.com/blockly/guides/contribute/get-started/commits). **The [Gitlint](https://jorisroovers.com/gitlint/latest) linter ensures in CI it's properly validated**
34+
- [ ] ✨ I have ensured my commit message prefix (e.g., `fix:`, `feat:`) matches the "Type of Change" I selected above.
35+
- [ ] β™½ I have run `make test` and `make lint` locally to check for and fix any
36+
issues. For an efficient workflow, I have considered installing
37+
[pre-commit](https://pre-commit.com/) and running `pre-commit install` to
38+
automate these checks.
39+
- [ ] πŸ“– I have added or updated documentation for any user-facing changes.
40+
- [ ] πŸ§ͺ I have added sufficient unit tests for my code changes.
41+
- [ ] 🎁 I have added end-to-end tests where feasible. See [README](https://github.com/openshift-pipelines/pipelines-as-code/blob/main/test/README.md) for more details.
42+
- [ ] πŸ”Ž I have addressed any CI test flakiness or provided a clear reason to bypass it.
43+
- [ ] If adding a provider feature, I have filled in the following and updated the provider documentation:
2344
- [ ] GitHub App
2445
- [ ] GitHub Webhook
2546
- [ ] Gitea/Forgejo
2647
- [ ] GitLab
2748
- [ ] Bitbucket Cloud
2849
- [ ] Bitbucket Data Center
29-
30-
(update the provider documentation accordingly)

0 commit comments

Comments
Β (0)