feat(#345): Issue templates - iteration#374
Conversation
- Improvements to clarity, - Constraints on required fields, - Fields marked with 'required: true' no longer have default filled values. This prevents uers from rushing through and submitting
|
I assume this PR reflects your issue templates repo 1:1? And I assume you completed this PR? |
|
@MordechaiHadad - Correct, the The currently open issues in the testing repo as This is completed and ready to merge. |
|
Alright, I'll play around with your repo to see if there's anything that needs changing, overall looks good for now. |
|
Hmmm a few questions
Overall good I have no complaints. |
|
Regarding 1 - No particular reason, happy to remove it, or replace with something else. |
a59f648
into
MordechaiHadad:add/issue-templates
Summary
Closes: #345
Additionally, iterates on: #372
(PR has been merged & closed as of creating this)
Details
Minor tweaks to most of the templates across the board, including the PR template.
Some of the changes include:
PR Template is marginally slimmer, and the long checklist has been put behind a collapsible - the collapsible section is most definitely up for debate as to whether we use.
Operating SystemandSystem Architecturenow use drop down's wherever available.I found this a lot clearer to work with over the free-form text area, and makes it both easier to submit, and clearer to create (and maintains consistency for skimming/scanning).
Default values in certain fields to help users maintain consistent formatting between opened
Issues.Default values are NOT present in fields that are marked as
required: trueto prevent users from mashing 'next' a bunch, then hitting submit.Code snippet for how to create a collapsible summary section now correctly formats as a code block (for users to copy-paste, users can also use a
/commands too).Most
Issuesnow use pre-provided 'labels' that are by-default available in create repos.Note
For the
04-build-problem.ymlto auto-tag, it will require creating a label that matches the label in the file (In this case it'sbuild-problem).This can be found via
Issues->Labels->New Label-> entering "build-problem" for name, and picking an interesting color.There are other smaller tweaks, mostly formatting and such.
As I had mentioned on the #372 PR that's been merged into a side-branch,
Issue TemplatesandPull Request Templatesare based on the default branch settings and cannot be used to target a different branch.I've got an open repo here where you're welcome to submit 'dummy' issues and PR's to see how they look and feel without having to direct merge them into the base branch here.