PolicyEngine / PolicyEngine/policyengine-us
Format yaml files
- Dominant language
- Python
- Stars
- 163
- Forks
- 213
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 96
Description
For example, using https://github.com/google/yamlfmt or https://lyz-code.github.io/yamlfix/ (these both seem more maintained than https://github.com/mmlb/yamlfmt/issues/17)
We could put this in our `make format`, and also customize it to add the `_` thousands separator.
This would also allow us to run programmatic operations over our yaml files and modify them using the yaml package, without polluting the commits with formatting changes.
Contributor guide
Research direction
Start by inspecting the existing `make format` target and how YAML files are handled with the Python YAML package. Compare the proposed `yamlfmt` and `yamlfix` tools, including whether they can preserve or add the `_` thousands separator. Done means YAML formatting is integrated into `make format` and programmatic YAML changes no longer create unrelated formatting churn.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100