diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 35f3aa88..b5133a56 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,8 +1,8 @@ # Description -[description] + -medic/pipeline#[number] + # Code review checklist diff --git a/README.md b/README.md index e7f2e5c2..725c029e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -A set of SQL queries that transform raw CouchDB data into a more useful format. It uses `dbt` to define the models that are translated into PostgreSQL tables or views, which makes it easier to query the data in the analytics platform of choice. +A set of SQL queries that transform raw CouchDB data into a more useful format for analytics. It uses `dbt` to define the models that are translated into PostgreSQL tables or views, which makes it easier to query the data in the analytics platform of choice. -## Local Setup -Follow the instructions in [the Local CHT Sync Setup documentation](https://docs.communityhealthtoolkit.org/apps/guides/data/analytics/setup/) to set up CHT Sync locally. +## Setup +Follow the instructions in [the CHT Sync documentation](https://docs.communityhealthtoolkit.org/hosting/analytics/) to set up the data pipeline. ## Run dbt models unit tests locally @@ -11,7 +11,7 @@ Follow the instructions in [the Local CHT Sync Setup documentation](https://docs ### Run the tests 1. Navigate to `tests` folder. -2. Run the test script +2. Run the test script: ```sh # set environment variables, install dbt dependencies, seed data, run dbt, run test