generated from Nugine/rust-template
-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
49 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# Development Guide | ||
|
||
## Requirements | ||
|
||
| Toolchain | Version | | ||
| :-----------------------------------: | :-----: | | ||
| [Rust](https://rustup.rs/) | ^1.74.0 | | ||
| [just](https://github.com/casey/just) | ^1.36.0 | | ||
|
||
## Workflow | ||
|
||
### Download source code | ||
|
||
```bash | ||
git clone https://github.com/Nugine/zuc.git | ||
cd zuc | ||
``` | ||
|
||
### Run basic checks and tests | ||
|
||
```bash | ||
just dev | ||
``` | ||
|
||
### Open documentation | ||
|
||
```bash | ||
just doc | ||
``` | ||
|
||
### Run CI checks locally | ||
|
||
```bash | ||
just ci | ||
``` | ||
|
||
## Git | ||
|
||
### Commit Message | ||
|
||
We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. | ||
|
||
### Pull Request | ||
|
||
Before creating or updating a pull request, please make sure to run the following commands and resolve any warnings or errors: | ||
|
||
```bash | ||
just dev | ||
``` |