EssentialsX / Essentials Public
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
Conversation
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. --> |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
| 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, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| demonstration of the feature. Similarly, if you are adding new API, | |
| demonstration of the feature. Similarly, if you are adding a new API, |
There was a problem hiding this comment.
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
| ### Information | ||
|
|
||
| <!-- | ||
| Replace #nnnn with the number of the original issue. If this PR implements |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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 |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
| Want faster support? Come join our Discord server to get help from both | ||
| developers and community members: https://discord.gg/F7gexAQ |
There was a problem hiding this comment.
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.
| 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 |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
| ### Information | ||
|
|
||
| <!-- | ||
| Replace #nnnn with the number of the original issue. If this PR implements |
There was a problem hiding this comment.
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, |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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. |
Adds new PR templates and revamps the existing issue templates to (hopefully) make the PR/issue submission easier to understand.
Adds new PR templates and revamps the existing issue templates to (hopefully) make the PR/issue submission easier to understand.