Skip to content

Conversation

@ashstewart7
Copy link
Member

@ashstewart7 ashstewart7 commented Dec 26, 2024

What issue is this solving?

Closes #4

Description

Adds templates for:

  • Creating a bug report based issue
  • Creating a feature request based issue
  • Creating a PR

GitHub has (since creating templates on the old project) implemented a new way of having issue templates through YAML defined forms. This seems neat so I've implemented them here, but am happy to backtrack and use the old MD-style if desired. Given the decreased flexibility of these in certain situations, I've enabled the option to override and create a blank issue if we ever need it.

PR still uses old format, due to the YAML form syntax not being supported here.

image
image

Any helpful knowledge/context for the reviewer?

  • Any new dependencies to install? ❌
  • Any special requirements to test? ✅ Since repos take the templates from main, testing requires a fork.
  • Any UI changes? Include screenshots if so. ❌

Feelings gif (optional)

copy pasting

Please make sure you've attempted to meet the following coding standards

  • Code has been tested and does not produce errors
  • Code is readable and formatted
  • There isn't any unnecessary commented-out code

Copy link
Collaborator

@aedwardg aedwardg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome!

@ashstewart7 ashstewart7 merged commit fbb28b6 into main Dec 26, 2024
2 checks passed
@ashstewart7 ashstewart7 deleted the 4-issue-pr-templates branch December 26, 2024 17:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add PR and Issue templates

3 participants