Styleguide to encourage consistent SQL
Open
Nobody has claimed this yet.
mimic-iii
- Dominant language
- Jupyter Notebook
- Stars
- 3.4k
- Forks
- 1.7k
- PR merge metrics
- No merged PRs in 30d
Description
We should consider adding a brief styleguide to the repository to encourage consistent formatting and syntax of SQL. It needn't be detailed - just setting out guidance on case, spacing etc should help to improve readability.
Couple of relevant links for reference:
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 file or test is named. Start by reviewing the repository's existing documentation structure and the two linked SQL style references, then add a brief guide covering case, spacing, and related formatting or syntax conventions. Done means the repository contains a concise, discoverable SQL styleguide.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- sql
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100