|
1 | 1 | # Changes <!-- 🎉🎉🎉 Thank you for the PR!!! 🎉🎉🎉 -->
|
2 | 2 |
|
3 |
| -<!-- Describe your changes here- ideally you can get that description straight from |
4 |
| -your descriptive commit message(s)! --> |
| 3 | +<!-- Describe your changes here- ideally you can get that description straight from your descriptive commit message(s)! --> |
5 | 4 |
|
6 | 5 | # Submitter Checklist
|
7 | 6 |
|
8 |
| -- [ ] 📝 Please ensure your commit message is clear and informative. For guidance on crafting effective commit messages, refer to the How to write a git commit message guide. We prefer the commit message to be included in the PR body itself rather than a link to an external website (ie: Jira ticket). |
| 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). |
9 | 8 |
|
10 |
| -- [ ] ♽ Before submitting a PR, run make test lint to avoid unnecessary CI processing. For an even more efficient workflow, consider installing [pre-commit](https://pre-commit.com/) and running pre-commit install in the root of this repository. |
| 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. |
11 | 10 |
|
12 |
| -- [ ] ✨ We use linters to maintain clean and consistent code. Please ensure you've run make lint before submitting a PR. Some linters offer a --fix mode, which can be executed with the command make fix-linters (ensure [markdownlint](https://github.com/DavidAnson/markdownlint) and [golangci-lint](https://github.com/golangci/golangci-lint) tools are installed first). |
| 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). |
13 | 12 |
|
14 |
| -- [ ] 📖 If you're introducing a user-facing feature or changing existing behavior, please ensure it's properly documented. |
| 13 | +- [ ] 📖 Document any user-facing features or changes in behavior. |
15 | 14 |
|
16 |
| -- [ ] 🧪 While 100% coverage isn't a requirement, we encourage unit tests for any code changes where possible. |
| 15 | +- [ ] 🧪 While 100% coverage isn't required, we encourage unit tests for code changes where possible. |
17 | 16 |
|
18 |
| -- [ ] 🎁 If feasible, please check if an end-to-end test can be added. See [README](https://github.com/openshift-pipelines/pipelines-as-code/blob/main/test/README.md) for more details. |
| 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. |
19 | 18 |
|
20 |
| -- [ ] 🔎 If there's any flakiness in the CI tests, don't necessarily ignore it. It's better to address the issue before merging, or provide a valid reason to bypass it if fixing isn't possible (e.g., token rate limitations). |
| 19 | +- [ ] 🔎 Address any CI test flakiness before merging, or provide a valid reason to bypass it (e.g., token rate limitations). |
21 | 20 |
|
22 |
| -- If you are adding a provider feature, please fill up the following details which provider this feature supports: |
| 21 | +- If adding a provider feature, fill in the following details: |
23 | 22 |
|
24 |
| - - [ ] GitHub |
25 |
| - - [ ] GitHub Webhook |
26 |
| - - [ ] Gitea |
27 |
| - - [ ] Gitlab |
28 |
| - - [ ] Bitbucket Cloud |
29 |
| - - [ ] Bitbucket Server/DC |
| 23 | +| Git Provider | Supported | |
| 24 | +|------------------|-----------| |
| 25 | +| GitHub App | ✅️ | |
| 26 | +| GitHub Webhook | ❌️ | |
| 27 | +| Gitea | ❌️ | |
| 28 | +| GitLab | ❌️ | |
| 29 | +| Bitbucket Cloud | ❌️ | |
| 30 | +| Bitbucket Server | ❌️ | |
30 | 31 |
|
31 |
| - (make sure to update the documentation accordingly) |
| 32 | + (update the documentation accordingly) |
0 commit comments