Improvement suggestion for readme
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 82/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Domain
- documentation
Research direction
Start by reading the repository README and the readme in dictionary/ to trace how the dictionary relates to the spec and to Claudish-to-English translation. Update the README so the dictionary directory's purpose, its relationship to the spec, and the effect of contributing to it are explicit; done when a newcomer can understand those workflows without guessing.
Written by the indexing model from the issue text.
Description
I found the spec to be helpful, at least conceptually.
However, I fail to get what the dictionary directory is used for from the readme. It seems like spec is not generated from the dictionary (which has been my assumption).
Also, I was under the impression that contributing to dic would help improve claudish -> english. I am wrong again because according to the readme in dictionary/.
This directory is the canonical source for the dictionary at programasweights.com/claudish/dictionary.
Even if I apply Claudish to English on this sentence, I still have no idea what it means.
Can you describe in readme the actual purpose of the dictionary directory with first-principle? Is it used for iterating the spec? What is it used for?
- Dominant language
- Python
- Stars
- 265
- Forks
- 24
- PR merge metrics
- No merged PRs in 30d
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.
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100