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

Add new PR templates and revamp issue templates #3711

Merged
merged 8 commits into from Oct 22, 2020
Merged

Conversation

mdcfe
Copy link
Member

@mdcfe mdcfe commented Oct 5, 2020

Adds new PR templates and revamps the existing issue templates to (hopefully) make the PR/issue submission easier to understand.

.github/ISSUE_TEMPLATE/help.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/report-a-bug.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/request-a-feature.md Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE/bug-fix.md Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE/bug-fix.md Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE/bug-fix.md Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE/new-feature.md Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE/new-feature.md Show resolved Hide resolved
@mdcfe mdcfe requested review from JRoy, Chew, Laarryy and pop4959 Oct 5, 2020
JRoy
JRoy previously approved these changes Oct 5, 2020
Laarryy
Laarryy previously approved these changes Oct 5, 2020
.github/ISSUE_TEMPLATE/request-a-feature.md Outdated Show resolved Hide resolved
@mdcfe mdcfe dismissed stale reviews from Laarryy and JRoy via a7b8d81 Oct 5, 2020
@mdcfe mdcfe requested review from JRoy and Laarryy Oct 5, 2020
JRoy
JRoy previously approved these changes Oct 6, 2020
Copy link
Member

@JRoy JRoy left a comment

Copy link
Member

@Chew Chew left a comment

Minor grammar nitpicks. Spelling is good, hacktoberfest PRs have successfully been avoided.

**Description**
<!-- Replace this with a brief summary of the bug. -->
**Description:**
<!-- What is the bug? Type a brief summary below this line. -->
Copy link
Member

@Chew Chew Oct 6, 2020

Choose a reason for hiding this comment

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

"brief summary" aren't summaries already brief?

Copy link
Member Author

@mdcfe mdcfe Oct 6, 2020

Choose a reason for hiding this comment

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

IMO while it might be redundant, it reinforces the fact we want a short and simple description here, not a massive unfocused paragraph.

.github/PULL_REQUEST_TEMPLATE/bug-fix.md Outdated Show resolved Hide resolved
3. Include a demonstration.
If you are adding commands, please provide screenshots and/or a video
demonstration of the feature. Similarly, if you are adding new API,
Copy link
Member

@Chew Chew Oct 6, 2020

Choose a reason for hiding this comment

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

Suggested change
demonstration of the feature. Similarly, if you are adding new API,
demonstration of the feature. Similarly, if you are adding a new API,

Copy link
Member

@pop4959 pop4959 Oct 7, 2020

Choose a reason for hiding this comment

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

Without 'a' reads better to me

.github/PULL_REQUEST_TEMPLATE/new-feature.md Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE/new-feature.md Show resolved Hide resolved
### Information

<!--
Replace #nnnn with the number of the original issue. If this PR implements
Copy link
Member

@Chew Chew Oct 6, 2020

Choose a reason for hiding this comment

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

Suggested change
Replace #nnnn with the number of the original issue. If this PR implements
Replace #nnnn with the number of the original issue. If this PR is implementing

Copy link
Member Author

@mdcfe mdcfe Oct 6, 2020

Choose a reason for hiding this comment

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

I don't feel this reads any better than the existing text

Copy link
Member

@pop4959 pop4959 Oct 7, 2020

Choose a reason for hiding this comment

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

I think I like the original as well

CONTRIBUTING.md Outdated Show resolved Hide resolved
Laarryy
Laarryy previously approved these changes Oct 6, 2020
Copy link

@Laarryy Laarryy left a comment

I likey likey

.github/ISSUE_TEMPLATE/help.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/help.md Outdated Show resolved Hide resolved
Want faster support? Come join our Discord server to get help from both
developers and community members: https://discord.gg/F7gexAQ
Copy link
Member

@pop4959 pop4959 Oct 7, 2020

Choose a reason for hiding this comment

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

Oftentimes Discord support is not fast since it is entirely driven by volunteers most hours of the day, so it would be good not to get people's expectations up.

Suggested change
Want faster support? Come join our Discord server to get help from both
developers and community members: https://discord.gg/F7gexAQ
Want an answer sooner? Join our Discord server to get help from community
members and sometimes even the developers themselves! Simply ask and wait
to see if anyone is able to help: https://discord.gg/F7gexAQ

Copy link
Member Author

@mdcfe mdcfe Oct 8, 2020

Choose a reason for hiding this comment

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

The text in this change feels clunky, and it carries pretty much the same meaning as before?

Copy link
Member

@pop4959 pop4959 Oct 8, 2020

Choose a reason for hiding this comment

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

Tried to keep most of the meaning the same, "sooner" does not imply "fast", and there is an emphasis put on community support over developer support (so people aren't expecting developers to always be available to respond). Lastly, "ask and wait" again to indicate that it may not be instant.

Could use some better wording, this was merely a suggestion.

.github/ISSUE_TEMPLATE/help.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/report-a-bug.md Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE/new-feature.md Outdated Show resolved Hide resolved
### Information

<!--
Replace #nnnn with the number of the original issue. If this PR implements
Copy link
Member

@pop4959 pop4959 Oct 7, 2020

Choose a reason for hiding this comment

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

I think I like the original as well

3. Include a demonstration.
If you are adding commands, please provide screenshots and/or a video
demonstration of the feature. Similarly, if you are adding new API,
Copy link
Member

@pop4959 pop4959 Oct 7, 2020

Choose a reason for hiding this comment

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

Without 'a' reads better to me

CONTRIBUTING.md Outdated
Contributing to EssentialsX
===========================

Want to help improve EssentialsX? There are numerous ways you can contribute to the project.
Copy link
Member

@pop4959 pop4959 Oct 7, 2020

Choose a reason for hiding this comment

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

Suggested change
Want to help improve EssentialsX? There are numerous ways you can contribute to the project.
Want to help improve EssentialsX? There are several ways you can contribute to the project.

CONTRIBUTING.md Outdated Show resolved Hide resolved
@mdcfe mdcfe dismissed stale reviews from Laarryy and JRoy via c9750fd Oct 8, 2020
@mdcfe mdcfe merged commit 327806d into 2.x Oct 22, 2020
1 check passed
@mdcfe mdcfe deleted the meta/github-pr-template branch Oct 22, 2020
Chew added a commit to Chew/Essentials that referenced this issue Nov 25, 2020
Adds new PR templates and revamps the existing issue templates to (hopefully) make the PR/issue submission easier to understand.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

6 participants