Contributing doc #127
Contributing doc #127
Conversation
|
Looks good to me so far! |
myronmarston
force-pushed
the
add-contributing-docs
branch
from
ebf1ae0 to
85df1e1
Compare
myronmarston
force-pushed
the
add-contributing-docs
branch
from
85df1e1 to
c9091c1
Compare
|
OK, I think this is ready for review. @lizrush, as the one who originally requested this (in rspec/rspec-mocks#986), can you take a look and let us know if this is the kind of thing you were looking for? Are there any general gotchas you ran into not covered here? You can see how these files look when rendered: |
| # Contributing | ||
|
|
||
| RSpec is a community-driven project that has benefited from improvements from over over *500* contributors. | ||
| We welcome contributions from *everyone*. While contributing, please follow the project [code of conduct](../code_of_conduct.md), so that everyone can be included. |
There was a problem hiding this comment.
Hmm, this code of conduct link doesn't appear to be working (at least not from https://github.com/rspec/rspec-core/blob/update-common-markdown-files-2015-07-24-for-master/CONTRIBUTING.md).
Any one got an idea for how to fix this? There's also the DEVELOPMENT file link below with the same problem.
|
Reading @lizrush's original request, we haven't covered everything on her list yet. (e.g. squash commits?) There's also a lot of material here, which could be intimidating. What do you think about a "Pull Request Checklist" somewhere near the top. (Maybe linking to relevant sections for more detail?) Something like:
This might also help with a feeling I have that the DEVELOPMENT file is too much information to fit in my head. It's a bit of a wall of text. Needs some kind of ToC or introduction. Checklist probably covers that. |
| to measure and enforce test coverage. If the coverage falls below a | ||
| project-specific threshold, the build will fail. | ||
|
|
||
| ## Cukes |
There was a problem hiding this comment.
Need to describe what is appropriate for cukes. Maybe:
- Cukes are our documentation. Only user facing examples that help demonstrate usage. Anything else should be in specs.
- Duplication between YARD and cukes is ok.
|
Thanks, @xaviershay. I covered some of your feedback but there's more to do (which I'll have to do another time -- time to put the kids to bed!). |
|
OK, @xaviershay, I think I addressed all your feedback. Let me know what you think of the new organization. You can see rendered examples on the rspec-core PR. |
|
Fantastic, thanks. Ship it! |
|
Thanks, @xaviershay. Merged in all repos |
Start of rspec/rspec-mocks#986. I'm kinda basing this off of bundler's files. More to come.