Skip to content

Commit

Permalink
docs: CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
Nugine committed Dec 10, 2024
1 parent 7d09649 commit 73a1bfd
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions CONTRIBUTING.md
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
```

0 comments on commit 73a1bfd

Please sign in to comment.