From 91d58646aed192a7bfb843150b95f18b3dd4930e Mon Sep 17 00:00:00 2001 From: "Miroslav V. Vasilev" Date: Tue, 18 Mar 2025 22:36:52 +0200 Subject: [PATCH] Improve docs --- docs/SETUP.md | 2 +- docs/TESTS.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/SETUP.md b/docs/SETUP.md index 01b8d0e..a6f584e 100644 --- a/docs/SETUP.md +++ b/docs/SETUP.md @@ -2,7 +2,7 @@ This project is built using golang `1.23.1`. -#### Setup steps +### Setup steps 1. Checkout this repository 2. Execute the script below diff --git a/docs/TESTS.md b/docs/TESTS.md index 27363eb..33f51c3 100644 --- a/docs/TESTS.md +++ b/docs/TESTS.md @@ -2,7 +2,7 @@ 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 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 ``` -#### Run Tests +### Run Tests 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 ./... ``` -#### Coverage +### Coverage 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: