diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 47c9496..570736a 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,8 +1,8 @@ # Description -[description] + -medic/sync#[number] + # Code review checklist @@ -13,4 +13,4 @@ medic/sync#[number] # License -The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license. \ No newline at end of file +The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license. diff --git a/README.md b/README.md index c462014..51658f0 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,17 @@ CHT Sync is an integrated solution designed to enable data synchronization between CouchDB and PostgreSQL for the purpose of analytics. Read more detail on the [CHT docs site](https://docs.communityhealthtoolkit.org/core/overview/cht-sync/). ## Using -See the [CHT docs site](https://docs.communityhealthtoolkit.org/apps/guides/data/analytics/setup)! + +See the [CHT docs site](https://docs.communityhealthtoolkit.org/hosting/analytics/)! ## Testing -See [testing](TESTING.md). \ No newline at end of file + +See [testing](TESTING.md). + +## Release Process + +This repo has an automated release process where each feature/bug fix will be released immediately after it is merged to `main`. The release type is determined by the commit message format. Have a look at the development workflow in the [Contributor Handbook](https://docs.communityhealthtoolkit.org/contribute/code/workflow/) for more information. + +### Commit message format + +The commit format should follow the convention outlined in the [CHT docs](https://docs.communityhealthtoolkit.org/contribute/code/workflow/#commit-message-format). diff --git a/TESTING.md b/TESTING.md index 3636e4a..e5e5ad6 100644 --- a/TESTING.md +++ b/TESTING.md @@ -11,6 +11,7 @@ In order to run these end-to-end tests locally, follow the steps below: ```sh npm ci ``` + 2. Run the `couch2pg` unit tests: ```sh