From aa78c4ce09268f67e46ede54d7ae8c8ae878f6aa Mon Sep 17 00:00:00 2001 From: Aaron Liu Date: Wed, 8 Jul 2026 10:19:04 +0800 Subject: [PATCH] doc: add contributing guidance --- CONTRIBUTING.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..23c918b4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,26 @@ +# Contributing to Cloudreve + +Thank you for your interest in contributing to Cloudreve! + +The full contributing guide — including project structure, development environment +setup, how to pick a task, how to submit a PR, and our AIGC (AI-generated code) +policy — is maintained in our documentation site: + +**👉 https://docs.cloudreve.org/api/contributing** + +A few key points to keep in mind before you open a PR: + +- Cloudreve is dual-licensed. We only accept contributions to the **community + edition**, and all contributors must sign the + [CLA](https://cla-assistant.io/cloudreve/cloudreve) before a PR can be merged. +- **PRs must be linked to an issue labeled with `Backlog`.** We do not accept + new features proposed directly through a PR. If you have a new idea, please + open an issue first and wait for it to be triaged and labeled. +- **Each PR should correspond to a single change.** Please split large features + or refactors into multiple smaller PRs whenever possible. +- If you use AI tools to help write code, please read the + [AIGC Guidelines](https://docs.cloudreve.org/api/contributing#aigc-guidelines) + first. We are not against AI, but we do not accept pure "vibe-coded" PRs. + +For discussion and support, join the `development` channel on our +[Discord community](https://discord.com/channels/1343585183047094367/1343585679585579018). \ No newline at end of file