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

chore: simplify GitHub templates #11466

Merged
merged 2 commits into from
Aug 26, 2018

Conversation

ncoden
Copy link
Contributor

@ncoden ncoden commented Aug 20, 2018

Description

Simplify the GitHub pull request and issues templates so they are easier and quicker to fill.

Changes

  • Adapt the templates to non-monospace fonts
  • Add some spacing
  • Reduce the number of asked questions
  • Reduce the number of required checks

Types of changes

  • Documentation
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing
    functionality to change)

Checklist (all required):

  • I have read and follow the CONTRIBUTING document.
  • There are no other pull request similar to this one.
  • The pull request title is descriptive.
  • The template is fully and correctly filled.
  • The pull request targets the right branch (develop or develop-v...).
  • My commits are correctly titled and contain all relevant information.
  • My code follows the code style of this project.
  • I have updated the documentation accordingly to my changes (if relevant).
  • I have added tests to cover my changes (if relevant).
  • All new and existing tests passed.

@ncoden ncoden changed the title [WIP] chore: simplify the GitHub pull request template chore: simplify the GitHub pr/issue templates Aug 20, 2018
@ncoden ncoden changed the title chore: simplify the GitHub pr/issue templates chore: simplify GitHub templates Aug 20, 2018
@ncoden ncoden removed the WIP label Aug 20, 2018
@DanielRuf
Copy link
Contributor

Adapt the templates to non-monospace fonts

Can you clarify this (what this means / solves)?

@SassNinja
Copy link
Contributor

@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
https://github.com/webpack/webpack/issues

Do you think we can adapt this?

@ncoden
Copy link
Contributor Author

ncoden commented Aug 21, 2018

Adapt the templates to non-monospace fonts

@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):
screen shot 2018-08-21 at 21 29 20

...is actually displayed like that on GitHub vanilla (proportional):
screen shot 2018-08-21 at 21 28 52

In this pull request, I changed the way comments I displayed so they is no ending characters.

Monospace:
screen shot 2018-08-21 at 21 36 00

Proportional (not perfect but much better).
screen shot 2018-08-21 at 21 36 10

@ncoden
Copy link
Contributor Author

ncoden commented Aug 21, 2018

@SassNinja

since you're reworking the github template, what do you think about removing all checkboxes?

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).

A comment to remind the reporter on this should also do the job.

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.

I really like how webpack does it when you create a new issue

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.

@ncoden
Copy link
Contributor Author

ncoden commented Aug 24, 2018

@SassNinja @DanielRuf Do my replies make sense to you ?

@ncoden ncoden merged commit bcd208d into foundation:develop Aug 26, 2018
@ncoden
Copy link
Contributor Author

ncoden commented Aug 26, 2018

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants