Skip to content

Improve Contributing Guidelines#7856

Merged
bevacqua merged 1 commit intomasterfrom
contrib
Jul 27, 2016
Merged

Improve Contributing Guidelines#7856
bevacqua merged 1 commit intomasterfrom
contrib

Conversation

@bevacqua
Copy link
Contributor

@bevacqua bevacqua commented Jul 27, 2016

Made the contributing guidelines a little more inviting by adding a table of contents and updating some of the wording to be more friendly and less about "this is how we do things".

@ycombinator
Copy link
Contributor

LGTM.

Probably out of scope for this PR but I'd like to rework this section holistically:

That said, a +1 isn't a vote. We keep up on highly commented issues. However, comments are but one of many reasons we might, or might not, work on an issue. A solid write up of your use case is more likely to make your case than a comment that says +10000.

Into something simpler like this:

That said, a +1 isn't a vote. While we keep up on highly +1'd issues, a solid write up of your use case is more likely to make your case than a comment that says +10000.

I can put up a separate PR for my proposed change.

@ycombinator ycombinator removed their assignment Jul 27, 2016
@bevacqua
Copy link
Contributor Author

@ycombinator Do it!

CONTRIBUTING.md Outdated

#### My issue isn't getting enough attention
First of all, sorry about that, we want you to have a great time with Kibana! You should join us on IRC ([#kibana](https://kiwiirc.com/client/irc.freenode.net/?#kibana) on freenode) and chat about it. Github is terrible for conversations. With that out of the way, there are a number of variables that go into deciding what to work on. These include priority, impact, difficulty, applicability to use cases, and last, and importantly: What we feel like working on.
First of all, sorry about that, we want you to have a great time with Kibana! You should join us on IRC ([#kibana](https://kiwiirc.com/client/irc.freenode.net/?#kibana) on freenode) and chat about it. GitHub is terrible for conversations. With that out of the way, there are a number of variables that go into deciding what to work on. These include priority, impact, difficulty, applicability to use cases, and last, and importantly: What we feel like working on.
Copy link
Contributor

@cjcenizal cjcenizal Jul 27, 2016

Choose a reason for hiding this comment

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

Maybe replace everything from "GitHub is terrible for conversations" onwards with just:

We prioritize issues according to impact and difficulty, so some issues can continually be overshadowed as more pressing issues arise.

I feel like "we work on what we feel like working on" sounds kind of juvenile, and also inaccurate. Thoughts?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agreed, definitely childish tone to it and kind of unapologetically "not our problem"

@cjcenizal
Copy link
Contributor

LGTM! Just 1 idea.

@cjcenizal
Copy link
Contributor

Great work! LGTM.

@bevacqua bevacqua changed the title Wording. Too many buts Improve Contributing Guidelines Jul 27, 2016
@bevacqua
Copy link
Contributor Author

@cjcenizal Could you do a second pass? 🎉

@cjcenizal
Copy link
Contributor

Looks good but the number of commits doesn't seem reflected in the diff.

@bevacqua
Copy link
Contributor Author

@cjcenizal Of course. Now just one commit :)

@cjcenizal
Copy link
Contributor

Great improvements! LGTM.

@Bargs Bargs self-assigned this Jul 27, 2016
CONTRIBUTING.md Outdated
Copy link
Contributor

Choose a reason for hiding this comment

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

How do you feel about explicitly saying "use issue reactions for +1s, don't write comments with just a +1"? I'd like this section to focus even more on encouraging well written, thoughtful comments. I'd suggest something like this:

"If an issue is important to you, add a comment with a solid write up of your use case and an explanation of why it's so important. Don't just comment with a 👍 . We seriously appreciate thoughtful comments. By sharing your thoughts we might even be able to come up with creative alternative solutions for your specific problem. If everything you'd like to say has already been said but you'd like to add a token of support, feel free to use the 👍 reaction on the issue itself and the comment which best summarizes your thoughts."

@Bargs
Copy link
Contributor

Bargs commented Jul 27, 2016

LGTM

@Bargs Bargs removed their assignment Jul 27, 2016
@bevacqua bevacqua merged commit b7c9124 into master Jul 27, 2016
@geekpete
Copy link
Contributor

LGTM

@bevacqua
Copy link
Contributor Author

Courté

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants