Skip to content
This repository was archived by the owner on Nov 9, 2017. It is now read-only.

add CONTRIBUTING.md content#88

Merged
2 commits merged intomasterfrom
hello
Jan 20, 2016
Merged

add CONTRIBUTING.md content#88
2 commits merged intomasterfrom
hello

Conversation

@ashleygwilliams
Copy link
Copy Markdown
Contributor

this is a draft for CONTRIBUTING.md. this will be a ToC from which we link to all the things, e.g. issue structure, admissions, etc.

cc: @nebrius @sup @Trott @Charlotteis

@ashleygwilliams
Copy link
Copy Markdown
Contributor Author

note #71 #85 are some of the docs this will link to

Comment thread CONTRIBUTING.md Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

May I recommend an emoji ✨ :sparkles:

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

yes pls

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

🏾 👋testing this

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

boo, there aren't different skin tone emojis on github

@varjmes
Copy link
Copy Markdown
Contributor

varjmes commented Jan 16, 2016

Just to check my understanding:

I think the idea is to get people started with the WG as quickly as possible. This WG is going to have more and more docs and policies and issues. People tend to skip to the important parts of the CONTRIBUTING to get to their goal as quickly as possible, so it's a good idea to make this as quick as possible by doing the leg work for them. In terms of just making the reading process more accessible, breaking something like this up into small parts makes a guide less overwhelming and thus more likely to be read.

yeah?

@ashleygwilliams
Copy link
Copy Markdown
Contributor Author

yeah that's my goal @Charlotteis -- do you think the current structure works? i don't plan on adding much more except links.

@varjmes
Copy link
Copy Markdown
Contributor

varjmes commented Jan 16, 2016

This is really clear and now that the appropriate emojis have been added, I'd be happy to see this merged :)

@ghost
Copy link
Copy Markdown

ghost commented Jan 16, 2016

LGTM! (so far at least)

Comment thread CONTRIBUTING.md
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

need an extra newline after the title (or make them ### headings); the GitHub markdown renderer puts the text that follows on the same line

@beaugunderson
Copy link
Copy Markdown
Contributor

some minor formatting/link stuff; otherwise pretty solid :)

Comment thread CONTRIBUTING.md Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

grammar nit: wish to file an issue I think?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

lol that's not grammar its an entire missing word hahahah

@nebrius nebrius mentioned this pull request Jan 17, 2016
@ashleygwilliams ashleygwilliams force-pushed the hello branch 3 times, most recently from 22e010f to b0349cf Compare January 18, 2016 15:01
@ashleygwilliams ashleygwilliams changed the title [WIP] add CONTRIBUTING.md content add CONTRIBUTING.md content Jan 18, 2016
@ghost
Copy link
Copy Markdown

ghost commented Jan 20, 2016

LGTM, merging!

This pull request was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants