chore: adding pr template - #20
Conversation
NucciTheBoss
left a comment
NucciTheBoss
left a comment
There was a problem hiding this comment.
Couple suggestions around updating the content of pull_request_template.md to be more relevant to this repository. For example, hpc-specs doesn't have a justfile or a CONTRIBUTING.md file 😅
| * [ ] I have ensured that lint, typecheck, and unit tests complete successfully. | ||
|
|
||
| [//]: # (If you can't run the tests locally, create a draft PR to check against the CI pipeline. Once you verify that CI is passing, you can take your PR out of draft status. Please try running the tests locally first, before testing against the CI pipeline.) |
There was a problem hiding this comment.
We should strip this bit from the PR template since this repository doesn't have a justfile, nor will it likely have recipes like typecheck or unit in the future.
| * [ ] I have ensured that lint, typecheck, and unit tests complete successfully. | |
| [//]: # (If you can't run the tests locally, create a draft PR to check against the CI pipeline. Once you verify that CI is passing, you can take your PR out of draft status. Please try running the tests locally first, before testing against the CI pipeline.) |
| @@ -0,0 +1,30 @@ | |||
| # Pre-submission checklist | |||
|
|
|||
| * [ ] I read and followed the CONTRIBUTING guidelines. | |||
There was a problem hiding this comment.
This repository doesn't have a CONTRIBUTING.md file either. We could likely copy the CONTRIBUTING.md file we have for the docs, but we need to yoink things like the make commands for linting the documentation, and we'd need to replace references to the docs with hpc-specs: https://github.com/canonical/charmed-hpc-docs/blob/main/CONTRIBUTING.md
2 participants
part of git migration