feat: create issue and PR templates#49
Conversation
|
this should come from automation repo i think? wouldn't it @natemoo-re? |
I'm not sure if they do. Just to clarify: templates have nothing to do with any workflow or CI. They are just there so when people create an issue or a PR, there are some prefilled options which guide you through writing clear language. It is helpful to welcome new contributors who are unsure of what to include in let's say a new docs issue. GitHub has some special functionality if you put those files into the |
|
So to give concrete examples, if you go to https://github.com/bombshell-dev/docs/issues/new/choose you can only see an option regarding security, which populates through https://github.com/bombshell-dev/.github/blob/main/SECURITY.md. After this PR gets merged, there will be another option, which is similar to Starlight's docs issue template: https://github.com/withastro/starlight/issues/new?template=---02-docs-issue.yml Regarding PR templates: Currently, when you open a new PR here, the description is empty. After this PR gets merged, the contents from |
|
The clack repo already has issue templates and as such it could be worth just taking those and putting them into the .github repo so that they apply to all the repos (and making any necessary tweaks) |
I oppose this because the clack templates are crafted for a repo that contains a package. This repo is just for docs. If you compare the PR template, they have entirely different sections, and the feature request issue template does not make much sense here. What we could do is extracting the clack templates into the .github repo but still override the templates here in the docs repo. I'll take a look to generalize the templates from clack so they fit to all other repos (docs excluded). Wdyt? |
|
this is better, extract what works for docs based on clack's issues templ 😄 |
This PR creates one issue form template for docs issues and also includes some helpful links on the choose issue type page, while still allowing for blank issues.
Moreover, it adds a small PR template.
This is opinionated, feel free to suggest changes!