From ad785db144cfbdcc7541d10643bf67cd989fa706 Mon Sep 17 00:00:00 2001
From: Mumulhl <mumulhl.666@gmail.com>
Date: Sun, 13 Apr 2025 11:41:16 +0800
Subject: [PATCH] docs(README): add contributing guidelines

---
 CONTRIBUTING.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++
 README.md       |  4 ++++
 README_CN.md    |  4 ++++
 3 files changed, 66 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..868b2f6
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,58 @@
+# Contributing to Ciyue
+
+Thank you for your interest in contributing to Ciyue!
+
+## Developing
+
+- Make your changes with clear, descriptive commit messages.
+- Ensure your code passes all tests.
+
+### Requirements
+
+- An editor, such as [VS Code](https://code.visualstudio.com/)
+- Flutter development environment. Follow [the official installation guide](https://docs.flutter.dev/get-started/install)
+
+### Using justfile
+
+We use [just](https://github.com/casey/just) as a command runner to simplify common development tasks.
+
+If you don't have just installed, follow the [installation guide](https://github.com/casey/just#installation).
+
+Common commands:
+
+```bash
+$ just build_runner      # Run code generation
+$ just make-migrations   # Generate database migrations
+$ just icon              # Generate app icons
+```
+
+### Build
+
+```bash
+$ flutter build android
+$ flutter build windows
+$ flutter build linux
+```
+
+### Running
+
+```bash
+$ flutter run
+```
+
+## Translations
+
+We welcome contributions to help translate Ciyue into more languages!
+
+[Translate Ciyue on Weblate](https://hosted.weblate.org/engage/ciyue/)
+
+Weblate makes it easy to collaborate on translations online. Please do not edit `.arb` files directly.
+
+## Reporting Issues
+
+- Search existing issues before opening a new one.
+- Provide detailed information to help us reproduce and fix the issue.
+
+## Final
+
+We appreciate your contributions!
\ No newline at end of file
diff --git a/README.md b/README.md
index f0df3a5..7c5e336 100644
--- a/README.md
+++ b/README.md
@@ -65,6 +65,10 @@ Thanks to their sponsorship for supporting the development of Ciyue!
 |爱发电用户_1b0db|
 |爱发电用户_nW9j|
 
+## Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how to contribute to this project.
+
 ## Contributors
 
 [![Contributor](https://contrib.rocks/image?repo=mumu-lhl/Ciyue)](https://github.com/mumu-lhl/Ciyue/graphs/contributors)
diff --git a/README_CN.md b/README_CN.md
index 2066910..389a6cd 100644
--- a/README_CN.md
+++ b/README_CN.md
@@ -64,6 +64,10 @@
 |爱发电用户_1b0db|
 |爱发电用户_nW9j|
 
+## 贡献指南
+
+请参阅 [CONTRIBUTING.md](./CONTRIBUTING.md) 以了解如何为本项目做出贡献。
+
 ## 贡献者
 
 <a href="https://github.com/mumu-lhl/Ciyue/graphs/contributors">