From 73a1bfd0de729bd3cac02daf5ca0aca587bcbd77 Mon Sep 17 00:00:00 2001
From: Nugine <nugine@foxmail.com>
Date: Tue, 10 Dec 2024 12:42:01 +0800
Subject: [PATCH] docs: CONTRIBUTING

---
 CONTRIBUTING.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..35ebe44
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -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
+```