docs
docs copied to clipboard
cucumber
Document build/contributing process for contributors
From @aslakhellesoy on March 21, 2017 23:47
It's a bit daunting for newcomers to find out where and how to make changes.
- Do I contribute in monorepo or subrepo?
- How do they get synced?
- What directory?
- How does CI work?
- What software do I need?
- How do I run a build on my machine?
- How can I find issues to help on?
- Where do I send pull requests?
- When do I get commit rights?
- Who's on the core team?
- How do I make a release?
There are some docs about this in the root folder (some of them are out of date). CONTRIBUTING.md is too long and boring.
Let's steal shamelessly from these great projects (with credits):
- http://hood.ie/contribute/
- https://github.com/exercism/exercism.io/blob/master/CONTRIBUTING.md
Some general guides for inspiration:
- https://opensource.guide/
- http://www.firsttimersonly.com/
- https://opensource.com/life/16/3/contributor-guidelines-template-and-tips
- https://guides.github.com/activities/contributing-to-open-source/
- http://contribution-guide-org.readthedocs.io/#
- http://www.writethedocs.org/guide/
Copied from original issue: cucumber/cucumber#167
From @mlvandijk on September 9, 2017 6:56
@aslakhellesoy Should this be in the docs.cucumber.io project? (can an issue be 'moved' or should it be replicated?) Also, having recently joined this is something I'd like to start on (at least starting from my own experience), possibly with some help (@js?)
From @stale[bot] on November 8, 2017 9:55
This issue has been automatically marked as stale because it has not had recent activity. It will be closed in a week if no further activity occurs.
From @mlvandijk on November 8, 2017 13:17
@aslakhellesoy Still think this is a good idea; maybe move it to the docs project?
Regarding libraries: https://docs.cucumber.io/docs/standard-library.html Is this still relevant / up to date?
The vision with standard libraries is still relevant. The information on the page is maybe not totally up to date.
Bump!! I have a hefty holiday break coming up in two weeks... I may dive into this!
Alongside this, I’m sure we could create a “commonly asked” faq for the users in the slack channels. We typically see the same / similar questions asked.
I'll help out with this as well. I've noticed for a long time that we could do with better contributor documentation.
