mvv/pilgrim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve docs

Browse source
This commit is contained in:
Miroslav Vasilev 2025-03-18 22:36:52 +02:00
parent 2b788b0e9c
commit 91d58646ae
Signed by: mvv
GPG key ID: 92BACFBE98721A3F
2 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/SETUP.md
View file

@ -2,7 +2,7 @@
This project is built using golang `1.23.1`. This project is built using golang `1.23.1`.
#### Setup steps ### Setup steps
1. Checkout this repository 1. Checkout this repository
2. Execute the script below 2. Execute the script below

6
docs/TESTS.md
View file

@ -2,7 +2,7 @@
Pilgrim's tests are written using the testify framework and mockery. Pilgrim's tests are written using the testify framework and mockery.
#### Generate Mocks ### Generate Mocks
The below command, when executed from the project root, will generate mocks for The below command, when executed from the project root, will generate mocks for
all interfaces in all packages of the project, and put them in the `mocks` all interfaces in all packages of the project, and put them in the `mocks`
@ -12,7 +12,7 @@ directory, under the `pilgrim_mock` package
$ mockery --all --outpkg pilgrim_mock --output ./internal/mocks $ mockery --all --outpkg pilgrim_mock --output ./internal/mocks
``` ```
#### Run Tests ### Run Tests
To run all tests, execute the following from the root directory To run all tests, execute the following from the root directory
@ -20,7 +20,7 @@ To run all tests, execute the following from the root directory
$ go test ./... $ go test ./...
``` ```
#### Coverage ### Coverage
To calculate test coverage, you have to build a special coverage binary and To calculate test coverage, you have to build a special coverage binary and
execute it. To do this, run the following in the root directory: execute it. To do this, run the following in the root directory: