diff --git a/README.md b/README.md index 1dfd63c..bd931ca 100644 --- a/README.md +++ b/README.md @@ -51,9 +51,11 @@ pg_restore -h localhost -U postgres -W -d dwh xero.dump This repo works in a trunk-based-development philosophy (). -When working on Data modeling stuff (models, sources, seeds, docs, etc.) use a `models` branch (i.e. `models/churned-users`). It's fine and encouraged to build incrementally towards a `reporting` level table with multiple PRs as long as you keep the model buildable along the way. +If your branch is related to a work item from DevOps, we encourage adding the ticket number in the branch name. For example: `models/123-some-fancy-name`. If you don't have a ticket number, you can simply do a `NOTICKET` one: `models/NOTICKET-some-fancy-name`. -For other matters, use a `chores` branch (i.e. `chores/add-dbt-package`). +When working on Data modeling stuff (models, sources, seeds, docs, etc.) use a `models` branch (i.e. `models/782-churned-users`). It's fine and encouraged to build incrementally towards a `reporting` level table with multiple PRs as long as you keep the model buildable along the way. + +For other matters, use a `chores` branch (i.e. `chores/656-add-dbt-package`). ## Project organization @@ -89,6 +91,9 @@ We organize models in three folders: - Split schema and domain with double underscode (ie `stg_core__booking`). - Always use sources to read into staging models. - SQL formatting should be done with `sqlfmt`. +- YAML files: + - Should use the `.yml` extension, not `.yaml`. + - Should be autoformatted on save. If you install [this vscode extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml), autoformatting should happen out of the box thanks to the settings included in the `.vscode/settings.json` file. - Other conventions - In staging, enforce a `lower()` to user UUID fields to avoid nasty propagations in the DWH. @@ -131,6 +136,4 @@ To maintain: ## Stuff that we haven't done but we would like to - Automate formatting with git pre-commit. -- Define conventions on testing (and enforce them). -- Define conventions on documentation (and enforce them). - Prepare a quick way to replicate parts of the `prd` dwh in our local machines.