Skip to content

Commit 6f3006c

Browse files
committed
add testing guidelines to README
1 parent 196eea0 commit 6f3006c

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,30 @@ The project is organized into several key directories:
100100
└── pkg
101101
```
102102

103+
## Testing
104+
105+
If you're adding new features, please make sure to include tests for them.
106+
107+
#### 1. Install the mockgen tool:
108+
109+
```shell
110+
go install go.uber.org/mock/mockgen@latest
111+
```
112+
113+
See the installation guide on [go.uber.org/mock](https://github.com/uber-go/mock?tab=readme-ov-file#installation).
114+
115+
#### 2. Use the following command to generate mock files:
116+
117+
```shell
118+
make generate-mocks
119+
```
120+
121+
#### 3. To run unit tests:
122+
123+
```shell
124+
make run-tests
125+
```
126+
103127
## Contributing
104128

105129
Feel free to open tickets or send pull requests with improvements. Thanks in advance for your help!

0 commit comments

Comments
 (0)