Proposal for Contributing Guidelines Documentation
Open
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 4.7k
- Forks
- 364
- PR merge metrics
- No merged PRs in 30d
Description
I would like to propose the creation of a Contributing Guidelines documentation for this project, since it doesn't have one at the moment. Clear guidelines would help people that want to contribute understand the best practices and it would streamline the contribution process for this project.
Contributor guide
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
No file, test, or entry point is named. Start by checking the repository for existing contribution documentation and project-specific contribution practices; done means a clear Contributing Guidelines document that explains the best practices and contribution process.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100