The-Strategy-Unit / The-Strategy-Unit/data_science
Add section about formatters
Open
Nobody has claimed this yet.
section: style guide
- Dominant language
- Jupyter Notebook
- Stars
- 11
- Forks
- 5
- Avg merge
- 5h 34m
- Merged PRs (30d)
- 1
Description
Add a section that outlines our preferences for the use of formatters in our repos.
Could include:
- tools, e.g. Air for R and Black for Python
- approaches, e.g. action failure, auto-formatting on push/merge, etc
- that we don't mandate any particular tool/approach
- examples from our open repos (maybe link to a typical Action script)
- note that the responsibility is on the codeowners of the repo to setup/advise/maintain
- links to IDE plugins
- config preferences, e.g. TOML Air
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.
Research direction
No target file or test is named. Start by locating the repository's documentation entry point and reviewing the open-repository Action examples mentioned in the issue; cover formatter tools, workflow approaches, ownership, IDE plugins, and configuration preferences. Done means the new section documents these preferences without mandating a tool or approach.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, python, r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100