Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update issue templates #4305

Merged
merged 4 commits into from
Oct 25, 2024
Merged

Update issue templates #4305

merged 4 commits into from
Oct 25, 2024

Conversation

theunrepentantgeek
Copy link
Member

What this PR does

Updates our issue templates to use markdown headings and to clarify the language.

Special notes for your reviewer

Our existing templates have been irritating me, so trying to make them better.

How does this PR make you feel

gif

@theunrepentantgeek theunrepentantgeek changed the title Update issue templats Update issue templates Sep 30, 2024
Copy link
Member

@matthchr matthchr left a comment

Choose a reason for hiding this comment

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

Left some comments, LMK what you think

.github/ISSUE_TEMPLATE/bug-report.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug-report.md Show resolved Hide resolved
@@ -7,4 +7,6 @@ assignees: ''

---

<Describe the feature request>
## Feature Request
Copy link
Member

Choose a reason for hiding this comment

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

Do we really need a heading here? We've already got the feature tag auto-added and the issue starts with Feature:, also saying ## Feature request at the top seems unneeded (to me).

Maybe just change from <> to _ and leave the rest of this one as-is?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yup.

.github/pull_request_template.md Show resolved Hide resolved
.github/pull_request_template.md Show resolved Hide resolved
@theunrepentantgeek theunrepentantgeek self-assigned this Oct 1, 2024
Copy link
Collaborator

@super-harsh super-harsh left a comment

Choose a reason for hiding this comment

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

LGTM! just a minor comment on contribution

<Describe the feature request>
_Describe the feature request._

<!--
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do you think its worth mentioning the link to contribution guide here and encourage users to contribute if they want to?

@theunrepentantgeek theunrepentantgeek added this pull request to the merge queue Oct 24, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Oct 24, 2024
@theunrepentantgeek theunrepentantgeek added this pull request to the merge queue Oct 25, 2024
Merged via the queue into main with commit fc7bb7f Oct 25, 2024
7 checks passed
@theunrepentantgeek theunrepentantgeek deleted the improve/issue-templates branch October 25, 2024 04:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

3 participants