PolicyEngine / PolicyEngine/policyengine-uk
Add and enforce parameter description style guide
Open
Nobody has claimed this yet.
code-health
documentation
- Dominant language
- Python
- Stars
- 50
- Forks
- 33
- Avg merge
- 20h 58m
- Merged PRs (30d)
- 14
Description
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 with the discussion in pull request 37's linked issue comment and read the referenced OpenFisca parameter-documentation guide. Determine the parameter description style that should be documented and how enforcement is expected to work; done means the guide and the repository's relevant descriptions or checks consistently follow that style.
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
- 25/100