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

Create Contributor's Guide #40

Closed
non opened this issue Feb 2, 2015 · 7 comments
Closed

Create Contributor's Guide #40

non opened this issue Feb 2, 2015 · 7 comments
Assignees

Comments

@non
Copy link
Contributor

non commented Feb 2, 2015

I've mentioned this while talking to many people, so I think it's something that we should get started on sooner rather than later.

Here are some things I imagine it doing:

  1. Set expectations for contributors
  2. Explain basic workflow, discussions, PR process, etc.
  3. Talk about project structure, modules, etc.
  4. Explain fundamental guiding principles
  5. Lay out best practices and encourage consistency
  6. Clearly document any exceptions or gotchas

We could use a wiki but I think I'd prefer a single Markdown document. I will try to start on this ASAP.

@ceedubs
Copy link
Contributor

ceedubs commented Feb 2, 2015

I plan on putting together a draft (that I'm sure will be heavily revised based upon feedback) for this within the next 36 hours.

@non
Copy link
Contributor Author

non commented Feb 3, 2015

One suggestion here -- let's push the branch used for this to origin, so that it is easier for different folks to push small fixes directly. I feel like the PR-to-a-PR could get tedious here, and we'll all be able to sign-off before it actually gets merged.

@ceedubs
Copy link
Contributor

ceedubs commented Feb 3, 2015

@non sounds like a good plan.

@stew
Copy link
Contributor

stew commented Feb 3, 2015

@ceedubs please take into consideration the discussion in this thread: #25 raised by @julien-truffaut

@ceedubs
Copy link
Contributor

ceedubs commented Feb 3, 2015

I created a rough draft (really more of a skeleton) on a contributor-guide branch. It is still mostly TODOs, but I wanted to get the general approach out there to see what people thought of it. Let me know what you think and I can keep trucking after work today if I'm trucking in the right direction.

@ceedubs
Copy link
Contributor

ceedubs commented Feb 3, 2015

Draft PR submitted: #47

@ceedubs
Copy link
Contributor

ceedubs commented Feb 6, 2015

I'm closing this since #47 was merged. I think we should create specific issues for any items we want to be updated in the contributor guide.

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

No branches or pull requests

3 participants