Add examples to rule catalog
Open
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 8
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
I'm trying to implement clear urls in Go, but it's hard to understand what each element should be doing. Is it possible to add some examples to the rule catalog?
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 locating and reading the rule catalog referenced in the issue, then review how its elements are currently explained. Add clear examples for the catalog rules and verify that each example makes the element's purpose understandable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100