Improve Contributability
Open
Nobody has claimed this yet.
documentation
good first issue
help wanted
- Dominant language
- C++
- Stars
- 3
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
I as a developer want to have an easy start into the project to help by contributing.
To improve the onboarding of new developers the project should provide a Contribution.md and a proper readme.md file.
- Create a contribution.md
- Improve the current readme.md
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 current readme.md to identify missing onboarding information and the project's existing contribution workflow. Create Contribution.md and improve readme.md; the work is done when both checklist items are addressed and a new developer can understand how to get started contributing.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100