micro-editor / micro-editor/micro
Add Contributor Docs
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 29.6k
- Forks
- 1.4k
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 10
Description
For both contributors and those looking to understand and/or reuse parts of micro, I think some documentation on how the codebase is structured, what the style guidelines are, etc. If this information is already available I apologize, however in that case I think a more clear link to where it is located would be helpful.
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 repository's existing documentation and contributor-facing links to determine what guidance already exists. Define the needed coverage for codebase structure and style guidelines, then add or clearly link that material so contributors and people reusing micro's code can find it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100