Skip to content

Commit 15ea55d

Browse files
committed
docs: add CONTRIBUTING.md
1 parent 7e45977 commit 15ea55d

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

CONTRIBUTING.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# :construction: Contributing to Enapter UCM Lua Libraries
2+
3+
Feel free to:
4+
5+
- 🐛 Report an issue
6+
- 📖 Improve documentation
7+
- 👨‍💻 Contribute to the code
8+
9+
## Creating a New Release
10+
11+
A new release should be generated by the following command:
12+
```sh
13+
./tools/new_release.sh X.Y.Z
14+
```
15+
16+
It generates new rockspec and updates the changelog. Please review the changes and commit it with:
17+
```sh
18+
git commit -m "release: vX.Y.Z"
19+
```

0 commit comments

Comments
 (0)