diff options
author | Evan Read <eread@gitlab.com> | 2023-04-11 04:07:18 +0300 |
---|---|---|
committer | Evan Read <eread@gitlab.com> | 2023-04-11 04:07:18 +0300 |
commit | 3252ddd0b4588f43c5c0551ff648c41a64b90236 (patch) | |
tree | 7177aa348631492d143e9d19cf324b1b9d14d7a6 /doc | |
parent | 55bc2d33b14df2cf6021beac68dc08cdf52d1143 (diff) |
Apply 4 suggestion(s) to 1 file(s)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/beginners_guide.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/beginners_guide.md b/doc/beginners_guide.md index 2ffca738f..b9dc8df02 100644 --- a/doc/beginners_guide.md +++ b/doc/beginners_guide.md @@ -135,8 +135,8 @@ If proto is updated, run `make`. This should compile successfully. Gitaly's tests are mostly in Go and we apply the following guidelines: -- each RPC must have end-to-end tests at the service level -- optionally, you can add unit tests for functions that need more coverage +- Each RPC must have end-to-end tests at the service level. +- (Optional) Add unit tests for functions that need more coverage. To run the full test suite, use `make test`. You'll need some [test repositories](test_repos.md), you can set these up with `make prepare-tests`. @@ -189,18 +189,18 @@ TEST_PACKAGES=./internal/gitaly/service/repository TEST_OPTIONS="-count=1 -run=T ### Praefect tests -Because Praefect lives in the same repository we need to provide database connection -information in order to run tests for it successfully. To get more info check out +Because Praefect lives in the same repository, we need to provide database connection +information to run tests for it successfully. For more information, see [glsql](../internal/praefect/datastore/glsql/doc.go) package documentation. -When you are using [GDK](https://gitlab.com/gitlab-org/gitlab-development-kit/) -the easiest way to run a Postgres database is by running: +When using [GDK](https://gitlab.com/gitlab-org/gitlab-development-kit/), +the easiest way to run a PostgreSQL database is by running: ```shell gdk start db ``` -Otherwise you can set up a Postgres database instance as a Docker container: +Otherwise, you can set up a PostgreSQL database instance as a Docker container: ```shell docker rm -f $(docker ps -q --all -f name=praefect-pg) > /dev/null 2>1; \ |