practicalli / practicalli/clojure-through-code
Review code examples
Open
Nobody has claimed this yet.
- Dominant language
- Clojure
- Stars
- 64
- Forks
- 13
- PR merge metrics
- No merged PRs in 30d
Description
Review all the code examples and ensure they are
- In the right category - organised by namespace that defines that category
- Includes a header comment to describe the category or context of examples
- Adds pointers to related files
- Includes expected outputs as comments underneath each expression
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
Start by inventorying the repository's Clojure code examples and grouping them by the namespace that defines each category. Review each example for a category header, pointers to related files, and expected output comments beneath expressions. Done means all examples follow these four consistency requirements.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- clojure
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100