-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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
chore: simplify GitHub templates #11466
chore: simplify GitHub templates #11466
Conversation
Can you clarify this (what this means / solves)? |
@ncoden since you're reworking the github template, what do you think about removing all checkboxes? In particular the checklist is quite annoying imo as you usually tick all boxes anyway. A comment to remind the reporter on this should also do the job. I really like how webpack does it when you create a new issue Do you think we can adapt this? |
@DanielRuf By default, GitHub use a "proportional" font, which mean that every character takes a different space according to its shape. Two lines with the same number of characters (but different) will not be aligned and will not end at the same position. So the following examples in monospace (when using Refined Github for example): ...is actually displayed like that on GitHub vanilla (proportional): In this pull request, I changed the way comments I displayed so they is no ending characters. |
I agree with you that it can be quite annoying for us. This is stuff we already know and we do not want to loose time filling an issue However, I think that this stuff is very helpful to newcomers and folks that do not contribute to the Open Source on a regular basis. We had a lot of badly formatted issues/pull requests before. Not that much since we added the checklist (new issues are most of the time correctly filled now).
Sadly I don't think this is enough. People tends to be bored by long texts and recommendations when there is no interaction possible or something to fill. I removed many items in the checklists for issues and pull requests. I think that asking the user to read CONTRIBUTING.md, follow the template, formatting its commit correctly and checking the branch he want to open the pull request on isn't too much asked.
Yeah I like this too. This was generated (any maybe adapted a bit) with https://www.talater.com/open-source-templates. I used it too for the old version of our templates. |
@SassNinja @DanielRuf Do my replies make sense to you ? |
@SassNinja I am merging this pull request as this it heading in the "no/less checkbox" direction. But we can continue discussing about removing them completly, I gave my arguments above. |
…emplate for v6.5.0 9f63941 chore: simplify the GitHub pull request template 0564f03 chore: simplify GitHub issue templates Signed-off-by: Nicolas Coden <[email protected]>
Description
Simplify the GitHub pull request and issues templates so they are easier and quicker to fill.
Changes
Types of changes
functionality to change)
Checklist (all required):
develop
ordevelop-v...
).I have updated the documentation accordingly to my changes (if relevant).I have added tests to cover my changes (if relevant).