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

docs: Update COLLABORATOR_GUIDE.md to include label meanings #4874

Merged
merged 5 commits into from Jan 30, 2018

Conversation

Projects
None yet
4 participants
@ldayananda
Contributor

ldayananda commented Jan 11, 2018

No description provided.

| bug | Issue | Marks as a confirmed bug |
| first-timers-only | Issue | Marks as a good bug or enhancement for first time contributors only |
| minor, patch, major | PR | Marks PR with the expected semver classification of the change |
| needs: LGTM | PR | Marks PR to be reviewed by a collaborator |

This comment has been minimized.

@mister-ben

mister-ben Jan 16, 2018

Contributor

is it worth mentioning the needs: more info and needs: reduced test case labels here or is there somewhere better for that?

This comment has been minimized.

@ldayananda

ldayananda Jan 16, 2018

Contributor

I was considering putting those in the CONTRIBUTING.md but wasn't sure which file they fit into better. Any preference?

This comment has been minimized.

@gkatsev

gkatsev Jan 16, 2018

Member

we probably want to have them here and in contributing.md with different explanations for the different audiences. In here with respect to what as a maintainer I should use and when and there with respect to when I'm contributing, what does it mean when something I opened or PRed was given a particular label.

@gkatsev

I think this is a great addition and could be merged as is, everything else can be done as separate PRs.

ldayananda added some commits Jan 17, 2018

@ldayananda

This comment has been minimized.

Contributor

ldayananda commented Jan 17, 2018

Added the labels section to CONTRIBUTING.md as well! 😄

@gkatsev

LGTM

@gkatsev gkatsev added confirmed patch and removed needs: LGTM labels Jan 22, 2018

| confirmed | Issue and PR | Issue: marks as reproducible by a maintainer. PR: marked by a maintainer as ready to be merged|
| 5.x | PR | Marks as a change to the 5.x branch only |
| bug | Issue | Marks as a confirmed bug by a maintainer |
| first-timers-only | Issue | Marked as a good bug or enhancement for first time contributors only |

This comment has been minimized.

@OwenEdwards

OwenEdwards Jan 23, 2018

Member

@gkatsev what's the difference between first-timers-only and good first issue? I thought good first issue was what you were flagging "a good bug or enhancement for first time contributors", but I'm not entirely clear why an issue would be for "first timers only". Are you suggesting that people who aren't "first timers" shouldn't work on those issues? That seems like it's much less important that "a first timer is encouraged to work on this issue rather than on more complicated ones", so I'd expect to see good first issue described here rather than first-timers-only.

This comment has been minimized.

@gkatsev

gkatsev Jan 23, 2018

Member

Maybe this is something to elaborate on but first-timers-only should be super simple issues that are strongly encouraged to be done by people who are coming into open source for the first time (or well, recently) and well-established people should try and not address those issues. good first issue can be directed at anyone as a good point to get into the project.
This was started by Kent C Dodds and he has a blog post about it: https://blog.kentcdodds.com/first-timers-only-78281ea47455
so far, I think using it has turned out pretty well.

This comment has been minimized.

@ldayananda

ldayananda Jan 24, 2018

Contributor

thanks for the question @OwenEdwards! I've updated both guides to be more clear on the meanings of these two labels.

ldayananda added some commits Jan 24, 2018

@gkatsev gkatsev merged commit a345971 into master Jan 30, 2018

4 checks passed

continuous-integration/codeship Build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details
deploy/netlify Deploy preview ready!
Details

@gkatsev gkatsev deleted the collaborator-update branch Jan 30, 2018

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