|
1 |
| -# Changes <!-- πππ Thank you for the PR!!! πππ --> |
| 1 | +## π Description of the Change |
2 | 2 |
|
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. --> |
4 | 4 |
|
5 |
| -# Submitter Checklist |
| 5 | +## π Linked GitHub Issue |
6 | 6 |
|
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 # |
8 | 8 |
|
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 |
10 | 10 |
|
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 |
12 | 13 |
|
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:`) |
14 | 20 |
|
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) --> |
16 | 22 |
|
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 |
18 | 24 |
|
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 |
20 | 30 |
|
21 |
| -- If adding a provider feature, fill in the following details: |
| 31 | +## β
Submitter Checklist |
22 | 32 |
|
| 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: |
23 | 44 | - [ ] GitHub App
|
24 | 45 | - [ ] GitHub Webhook
|
25 | 46 | - [ ] Gitea/Forgejo
|
26 | 47 | - [ ] GitLab
|
27 | 48 | - [ ] Bitbucket Cloud
|
28 | 49 | - [ ] Bitbucket Data Center
|
29 |
| - |
30 |
| - (update the provider documentation accordingly) |
|
0 commit comments