Skip to content

Commit 2cee166

Browse files
committed
doc: add hints for contributors
Described how to setup necessary environment and regenerate the resulting `index.js` file to ease a pathway of a first time contributor like me.
1 parent e7e514e commit 2cee166

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

HACKING.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
## First steps
2+
3+
Clone the repository and install dependencies.
4+
5+
```shell
6+
$ git clone [email protected]:tarantool/setup-tarantool.git
7+
$ cd setup-tarantool
8+
$ npm install
9+
```
10+
11+
## Contribute
12+
13+
Edit the source and regenerate the `index.js` file.
14+
15+
```shell
16+
$ vim src/main.ts
17+
$ npm run pre-checkin
18+
```

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,5 @@ The scripts and documentation in this project are released under the [MIT Licens
4242
# Contributions
4343
4444
Contributions are welcome! Just open an issue or send a pull request.
45+
46+
Check out [HACKING.md](./HACKING.md) file for hints.

0 commit comments

Comments
 (0)