Feat(governance): Added PR & ISSUES templates#3
Conversation
jpmewenemesse
commented
Apr 30, 2026
jpmewenemesse
commented
- Added ISSUE_TEMPLATE: bug report and new feature request
- Added PR template
- Made sure someone cannot create a blank issue without using the template
…template, fix newline issue
| - [ ] Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/) | ||
| - [ ] I have tested my changes | ||
| - [ ] Documentation updated if needed | ||
| - [ ] All CI checks pass if configured |
There was a problem hiding this comment.
Should be this a default behavior of the pull request ci ?
| ## Checklist | ||
|
|
||
| - [ ] I have read [CONTRIBUTING.md](https://github.com/OKDP/.github/blob/main/CONTRIBUTING.md) | ||
| - [ ] Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/) |
There was a problem hiding this comment.
could it be integrated to ci checks directly ? Even Better we should have pre-commit hooks available (husky or pre-commit)
There was a problem hiding this comment.
For TDP we use this workflow https://github.com/TOSIT-IO/tdp-collection/blob/master/.github/workflows/conventional-commits.yml
There was a problem hiding this comment.
I did checked what you did in TDP wich is great and can be replicated for OKDP. We have two options:
- Create
.github/workflowinside that.githubpublic repo. It means when calling in each repo ci, we will be using something likeuses: OKDP/.github/.github/workflow/conventional-commits.yml@main
Cons: The path is kind of weird to me specialiy that .github/.github. This is not a standard even tough it will work.
Pros: No additional repo to create
- The second option will be to create a shared github actions repo. we can call it
gha-workflowsorshared-workflows. That way when calling it on allOKDPrepos we will be usinguses: OKDP/gha-workflows/.github/workflows/conventional-commits@main.
Cons: I dont find any cons
Pros: we have a dedicated shared gh actions and easy to maintain. Most open source projects adopt this way of providing shared gh actions.
If you guys are ok, I will go for the second option and remove the conventional commits checks from the checklist in PULL REQUEST TEMPLATE.
nviault-dgfip
left a comment
nviault-dgfip
left a comment
There was a problem hiding this comment.
ISSUE_TEMPLATE/bug_report.yml
Line 55 : The version --short option is deprecated
example on Ubuntu 24.04
kubectl version --short
error: unknown flag: --short
See 'kubectl version --help' for usage.
…onventional commits check on PR checklist
Corrected. Thanks |
5 participants
