redhat-developer / redhat-developer/mapt
[doc] Added some guidelines for development
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Go
- Stars
- 24
- Forks
- 36
- Avg merge
- 6d 13h
- Merged PRs (30d)
- 8
Description
Maybe adding some basic doc about the project structure and naming convention
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
Review the repository structure and existing documentation to determine where contributor guidance belongs. Document the project structure and naming conventions, and consider the work done when newcomers can use the added guidance to navigate the project and name changes consistently.
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