Skip to content

Commit 57710ee

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. 1. https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions
1 parent 11750fd commit 57710ee

File tree

2 files changed

+30
-24
lines changed

2 files changed

+30
-24
lines changed

CONTRIBUTING.md

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

README.md

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

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

143-
## Tests
143+
## Contributing
144144

145-
You need to [install Tarantool](https://www.tarantool.io/en/download/) to run tests.
146-
See [Installation](#installation) section for requirements.
147-
148-
To install test dependencies (like [tarantool/queue](https://github.com/tarantool/queue) module), run
149-
```bash
150-
make deps
151-
```
152-
153-
To run tests for the main package and each subpackage, call
154-
```bash
155-
make test
156-
```
157-
Tests set up all required `tarantool` processes before run and clean up after.
158-
159-
If you want to run a specific package tests, call
160-
```bash
161-
make test-<SUBDIR>
162-
```
163-
For example, for running tests in `multi`, `uuid` and `main` packages, call
164-
```bash
165-
make test-multi test-uuid test-main
166-
```
145+
See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how
146+
to get started with our project.
167147

168148
## Alternative connectors
169149

0 commit comments

Comments
 (0)