Create contributors guide
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 6.5k
- Forks
- 456
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 5
Description
I have been looking in to contributing to ShareDB lately, but I didn't see a contributors guide or anything of the like.
Would have been/would still be helpful.
I am willing to author/template out one and make a PR with some guidance from the core team.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the ShareDB repository and the linked contributor-guidelines reference to determine what a contributors guide should cover. Confirm the expected guidance with the core team, then ensure the finished guide explains how newcomers can contribute to ShareDB.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100