Skip to content

Commit 187741c

Browse files
committed
Add a simple contributing guide
1 parent f7c0d64 commit 187741c

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Contributing guide
2+
3+
PRs are welcome!
4+
5+
This guide is quite barebones - if you have any questions, feel free to open an issue or contact [@MMK21](https://github.com/MMK21Hub/).
6+
7+
## Setup
8+
9+
We use Rust and Cargo, as is standard for most Rust projects.
10+
11+
## Publishing a new release
12+
13+
1. Bump version
14+
- Ensure Cargo.toml and Cargo.lock are commited
15+
2. Run `build_binaries.sh`
16+
- See the script for usage details
17+
3. Create a GitHub release
18+
- Auto-generate release notes from PR titles & add some blurb

0 commit comments

Comments
 (0)