PolicyEngine / PolicyEngine/policyengine-uk
More consistent phrasing in descriptions
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 50
- Forks
- 33
- Avg merge
- 20h 58m
- Merged PRs (30d)
- 14
Description
Some descriptions are phrased the same way as the label, some say the name of the parameter is some description, some are basically the same as the description just made longer to not be the same, some are phrased differently.
Let's define a standard.
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
The issue names no files, tests, or entry points; start by locating the parameter labels and descriptions illustrated in the screenshots. Compare the existing phrasing patterns, agree on a consistent standard, and update the affected descriptions so they follow it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100