Ram's Style Guide
This page is a work in progress. But as I polish the sections that already exist, I am adding more rough draft sections. This pushes the page further from being merge-ready and risks leaving it in feature-branch purgatory forever. In theory, I could have feature branches on feature branches, but I don’t like that.
Calendaring
Type | Color | Notes | Comment | |
---|---|---|---|---|
Sleep | Graphite | Good | ||
Social Event | Tomato | With other people | Good | |
Reminder | Tangerine | Zero-length even | Good | |
Context Change Errand | Flamingo | |||
No Context Change Errand | Lavender | |||
Alive Time | Gold | |||
Employment | Sage | |||
Outside | Flamingo | Go somewhere without order people but not an errand? |
Regarding errands:
What is Get Ready for Work
vs Go to Longos
vs Workout at home
? Are they all errands?
I feel like indoor/outdoor errands are different. Or maybe the distinction is between errands which require context/environment changes and ones which don’t.
So Workout at home
and Go to Longos
are Context Change Errands, but Get Ready for Work
is not
This calendaring section does not feel done, but it is probably my personal most visited page. It’s annoying to go to the GitHub pull request, then the Cloudflare Pages preview, and then All Pages and then Style Guide. So, let’s just merge it in.
Dates
- Dates should whenever possible be written YYYY-MM-DD. See RFC 3339
full-date
Python
Dependency Management
- I almost always use pipenv and PipFile (But maybe I should be using poetry and pyproject.toml)
Libraries
Purpose | Preferred |
---|---|
Web Scraping | BS4 |
HTTP Requests | requests |
SQLite frontend | datasette |
SQLite ORM | sqlite-utils (for simple SQLite) |
Licence
- I prefer the MIT licence because it is the default permissive licence