From 1f0fd8215a7cbb56205d77ab9bcc6f646a1ea052 Mon Sep 17 00:00:00 2001 From: Phantom Date: Sun, 26 Oct 2025 00:14:27 +0800 Subject: [PATCH] docs: update PR template and README with feature PR restrictions (#10955) * docs: update PR template and README with feature PR restrictions Add temporary hold notice for Redux/IndexedDB feature PRs in both pull request template and README Fix whitespace and formatting inconsistencies in README * docs: update contributing guidelines with temporary PR restrictions Add important notice about temporary restrictions on data-changing feature PRs Clarify acceptable contribution types during v2.0.0 development phase * docs: remove warning about feature PR restrictions The warning about temporary restrictions on feature PRs involving Redux or IndexedDB changes has been removed as it is no longer relevant * docs: remove core developer membership section from contributing guides --- .github/pull_request_template.md | 12 ++++++++++++ CONTRIBUTING.md | 23 ++++++++++++++++++++++- README.md | 8 ++++---- docs/CONTRIBUTING.zh.md | 23 ++++++++++++++++++++++- 4 files changed, 60 insertions(+), 6 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 72e175baf..03b71ecec 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -3,6 +3,18 @@ 1. Consider creating this PR as draft: https://github.com/CherryHQ/cherry-studio/blob/main/CONTRIBUTING.md --> + + ### What this PR does Before this PR: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 408057252..88f034976 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -65,7 +65,28 @@ The Test Plan aims to provide users with a more stable application experience an ### Other Suggestions - **Contact Developers**: Before submitting a PR, you can contact the developers first to discuss or get help. -- **Become a Core Developer**: If you contribute to the project consistently, congratulations, you can become a core developer and gain project membership status. Please check our [Membership Guide](https://github.com/CherryHQ/community/blob/main/docs/membership.en.md). + +## Important Contribution Guidelines & Focus Areas + +Please review the following critical information before submitting your Pull Request: + +### Temporary Restriction on Data-Changing Feature PRs 🚫 + +**Currently, we are NOT accepting feature Pull Requests that introduce changes to our Redux data models or IndexedDB schemas.** + +Our core team is currently focused on significant architectural updates that involve these data structures. To ensure stability and focus during this period, contributions of this nature will be temporarily managed internally. + +* **PRs that require changes to Redux state shape or IndexedDB schemas will be closed.** +* **This restriction is temporary and will be lifted with the release of `v2.0.0`.** You can track the progress of `v2.0.0` and its related discussions on issue [#10162](https://github.com/YOUR_ORG/YOUR_REPO/issues/10162) (please replace with your actual repo link). + +We highly encourage contributions for: +* Bug fixes 🐞 +* Performance improvements 🚀 +* Documentation updates 📚 +* Features that **do not** alter Redux data models or IndexedDB schemas (e.g., UI enhancements, new components, minor refactors). ✨ + +We appreciate your understanding and continued support during this important development phase. Thank you! + ## Contact Us diff --git a/README.md b/README.md index 634a4fc73..c3d3f915a 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@

English | 中文 | Official Site | Documents | Development | Feedback

- + [![][deepwiki-shield]][deepwiki-link] [![][twitter-shield]][twitter-link] [![][discord-shield]][discord-link] @@ -45,7 +45,7 @@
- + [![][github-release-shield]][github-release-link] [![][github-nightly-shield]][github-nightly-link] [![][github-contributors-shield]][github-contributors-link] @@ -248,10 +248,10 @@ The Enterprise Edition addresses core challenges in team collaboration by centra | Feature | Community Edition | Enterprise Edition | | :---------------- | :----------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------- | -| **Open Source** | ✅ Yes | ⭕️ Partially released to customers | +| **Open Source** | ✅ Yes | ⭕️ Partially released to customers | | **Cost** | Free for Personal Use / Commercial License | Buyout / Subscription Fee | | **Admin Backend** | — | ● Centralized **Model** Access
● **Employee** Management
● Shared **Knowledge Base**
● **Access** Control
● **Data** Backup | -| **Server** | — | ✅ Dedicated Private Deployment | +| **Server** | — | ✅ Dedicated Private Deployment | ## Get the Enterprise Edition diff --git a/docs/CONTRIBUTING.zh.md b/docs/CONTRIBUTING.zh.md index 7574990cd..67193ed09 100644 --- a/docs/CONTRIBUTING.zh.md +++ b/docs/CONTRIBUTING.zh.md @@ -69,7 +69,28 @@ git commit --signoff -m "Your commit message" ### 其他建议 - **联系开发者**：在提交 PR 之前，您可以先和开发者进行联系，共同探讨或者获取帮助。 -- **成为核心开发者**：如果您能够稳定为项目贡献，恭喜您可以成为项目核心开发者，获取到项目成员身份。请查看我们的[成员指南](https://github.com/CherryHQ/community/blob/main/membership.md) + +## 重要贡献指南与关注点 + +在提交 Pull Request 之前，请务必阅读以下关键信息： + +### 🚫 暂时限制涉及数据更改的功能性 PR + +**目前，我们不接受涉及 Redux 数据模型或 IndexedDB schema 变更的功能性 Pull Request。** + +我们的核心团队目前正专注于涉及这些数据结构的关键架构更新和基础工作。为确保在此期间的稳定性与专注，此类贡献将暂时由内部进行管理。 + +* **需要更改 Redux 状态结构或 IndexedDB schema 的 PR 将会被关闭。** +* **此限制是临时性的，并将在 `v2.0.0` 版本发布后解除。** 您可以通过 Issue [#10162](https://github.com/YOUR_ORG/YOUR_REPO/issues/10162) (请替换为您的实际仓库链接) 跟踪 `v2.0.0` 的进展及相关讨论。 + +我们非常鼓励以下类型的贡献： +* 错误修复 🐞 +* 性能改进 🚀 +* 文档更新 📚 +* 不改变 Redux 数据模型或 IndexedDB schema 的功能（例如，UI 增强、新组件、小型重构）。✨ + +感谢您在此重要开发阶段的理解与持续支持。谢谢！ + ## 联系我们