Skip to content

Commit e6a045e

Browse files
committed
readme: move section about testing to contributing guide
There is a guide made by Github with recommendations how to make project healthy for contributors [1]. One of them is a contributing guide with steps for new contributors. Knowledge about running tests in a project is not needed to all people who will read our README, so I moved this section to contributing guide. Part of #123 1. https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions
1 parent dbef3fd commit e6a045e

File tree

2 files changed

+33
-24
lines changed

2 files changed

+33
-24
lines changed

CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Contribution Guide
2+
3+
## Running tests
4+
5+
You need to [install Tarantool](https://tarantool.io/en/download/) to run tests.
6+
See the Installation section in the README for requirements.
7+
8+
To install test dependencies (such as the
9+
[tarantool/queue](https://github.com/tarantool/queue) module), run:
10+
```bash
11+
make deps
12+
```
13+
14+
To run tests for the main package and each subpackage:
15+
```bash
16+
make test
17+
```
18+
19+
The tests set up all required `tarantool` processes before run and clean up
20+
afterwards.
21+
22+
If you want to run the tests for a specific package:
23+
```bash
24+
make test-<SUBDIR>
25+
```
26+
For example, for running tests in `multi`, `uuid` and `main` packages, call
27+
```bash
28+
make test-multi test-uuid test-main
29+
```

README.md

Lines changed: 4 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ faster than other packages according to public benchmarks.
2626
* [API reference](#api-reference)
2727
* [Walking\-through example in Go](#walking-through-example-in-go)
2828
* [Help](#help)
29-
* [Tests](#tests)
29+
* [Contributing](#contributing)
3030
* [Alternative connectors](#alternative-connectors)
3131

3232
## Installation
@@ -164,30 +164,10 @@ To contact `go-tarantool` developers on any problems, create an issue at
164164
The developers of the [Tarantool server](http://github.com/tarantool/tarantool)
165165
will also be happy to provide advice or receive feedback.
166166

167-
## Tests
167+
## Contributing
168168

169-
You need to [install Tarantool](https://www.tarantool.io/en/download/) to run tests.
170-
See [Installation](#installation) section for requirements.
171-
172-
To install test dependencies (like [tarantool/queue](https://github.com/tarantool/queue) module), run
173-
```bash
174-
make deps
175-
```
176-
177-
To run tests for the main package and each subpackage, call
178-
```bash
179-
make test
180-
```
181-
Tests set up all required `tarantool` processes before run and clean up after.
182-
183-
If you want to run a specific package tests, call
184-
```bash
185-
make test-<SUBDIR>
186-
```
187-
For example, for running tests in `multi`, `uuid` and `main` packages, call
188-
```bash
189-
make test-multi test-uuid test-main
190-
```
169+
See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how
170+
to get started with our project.
191171

192172
## Alternative connectors
193173

0 commit comments

Comments
 (0)