build-harness icon indicating copy to clipboard operation
build-harness copied to clipboard

Modernize templates

Open nitrocode opened this issue 3 years ago • 0 comments

what

  • [x] Convert bug report type to yaml
  • [x] Convert feature request type to yaml
  • [x] Use comments and dashes in PR template
  • [ ] Get reviews from multiple team members

why

  • Modernize our templates
  • Use YAML so the prompts are more structured
  • Comment out PR template placeholder text so the user can add uncommented text without having to delete the placeholder text
  • Dashes in PR template instead of asterisks as this is recommended by prettier and it saves some typing. The dash is a single key whereas the asterisk is a SHIFT + 8.
    • @korenyoni originally recommended this and we've been doing this in clients.

references

  • https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository
  • https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
  • https://github.com/prettier/prettier/issues/4251
  • See preview of PR template
  • See below for screenshots of the new bug report and feature request templates
image image

nitrocode avatar Jul 15 '22 21:07 nitrocode