diff --git a/README.md b/README.md index 96f727a96e..e5315f5ce9 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,7 @@ Refer to the [development documentation](docs/dev.md) Refer to the [Architecture overview documentation](https://deepwiki.com/CherryHQ/cherry-studio) -Refer to the [Branching Strategy](docs/branching-strategy.md) for contribution guidelines +Refer to the [Branching Strategy](docs/branching-strategy-en.md) for contribution guidelines # 🤝 Contributing diff --git a/docs/README.ja.md b/docs/README.ja.md index 02983db685..ce5d2f6ef7 100644 --- a/docs/README.ja.md +++ b/docs/README.ja.md @@ -6,17 +6,19 @@

English | 中文 | 日本語

+
kangfenmao%2Fcherry-studio | Trendshift Cherry Studio - AI Chatbots, AI Desktop Client | Product Hunt
+ # 🍒 Cherry Studio Cherry Studio は、複数の LLM プロバイダーをサポートするデスクトップクライアントで、Windows、Mac、Linux で利用可能です。 👏 [Telegram](https://t.me/CherryStudioAI)｜[Discord](https://discord.gg/wez8HtpxqQ) | [QQグループ(575014769)](https://qm.qq.com/q/lo0D4qVZKi) -❤️ Cherry Studio をお気に入りにしましたか？小さな星をつけてください 🌟 または [スポンサー](sponsor.md) をして開発をサポートしてください！❤️ +❤️ Cherry Studio をお気に入りにしましたか？小さな星をつけてください 🌟 または [スポンサー](sponsor.md) をして開発をサポートしてください！ # 📖 ガイド @@ -56,7 +58,7 @@ https://docs.cherry-ai.com - 🔤 AI による翻訳機能 - 🎯 ドラッグ＆ドロップによる整理 - 🔌 ミニプログラム対応 -- ⚙️ MCP（モデルコンテキストプロトコル） サービス +- ⚙️ MCP（モデルコンテキストプロトコル）サービス 5. **優れたユーザー体験**： @@ -70,71 +72,78 @@ https://docs.cherry-ai.com - [x] クイックポップアップ（クリップボードの読み取り、簡単な質問、説明、翻訳、要約） - [x] 複数モデルの回答の比較 -- [x] サービスプロバイダーが提供する SSO を使用したログインをサポート -- [x] すべてのモデルがネットワークをサポート +- [x] サービスプロバイダーが提供する SSO を使用したログイン対応 +- [x] すべてのモデルのネットワーク対応 - [x] 最初の公式バージョンのリリース -- [ ] 錯誤修復と改善 (開発中...) +- [x] バグ修正と改善（進行中...） - [ ] プラグイン機能（JavaScript） - [ ] ブラウザ拡張機能（テキストをハイライトして翻訳、要約、ナレッジベースに追加） - [ ] iOS & Android クライアント -- [ ] AIノート +- [ ] AI ノート - [ ] 音声入出力（AI コール） -- [ ] データバックアップはカスタムバックアップコンテンツをサポート +- [ ] データバックアップのカスタマイズ対応 # 🌈 テーマ -- テーマギャラリー: https://cherrycss.com -- Aero テーマ: https://github.com/hakadao/CherryStudio-Aero -- PaperMaterial テーマ: https://github.com/rainoffallingstar/CherryStudio-PaperMaterial -- Claude テーマ: https://github.com/bjl101501/CherryStudio-Claudestyle-dynamic -- メープルネオンテーマ: https://github.com/BoningtonChen/CherryStudio_themes +- テーマギャラリー：https://cherrycss.com +- Aero テーマ：https://github.com/hakadao/CherryStudio-Aero +- PaperMaterial テーマ：https://github.com/rainoffallingstar/CherryStudio-PaperMaterial +- Claude テーマ：https://github.com/bjl101501/CherryStudio-Claudestyle-dynamic +- メープルネオンテーマ：https://github.com/BoningtonChen/CherryStudio_themes -より多くのテーマのPRを歓迎します +より多くのテーマの PR を歓迎します # 🖥️ 開発 -参考[開発ドキュメント](dev.md) +[開発ドキュメント](dev.md)を参照してください + +[アーキテクチャ概要ドキュメント](https://deepwiki.com/CherryHQ/cherry-studio)を参照してください + +[ブランチ戦略](branching-strategy-en.md)を参照して貢献ガイドラインを確認してください # 🤝 貢献 Cherry Studio への貢献を歓迎します！以下の方法で貢献できます： -1. **コードの貢献**：新機能を開発するか、既存のコードを最適化します。 -2. **バグの修正**：見つけたバグを修正します。 -3. **問題の管理**：GitHub の問題を管理するのを手伝います。 -4. **製品デザイン**：デザインの議論に参加します。 -5. **ドキュメントの作成**：ユーザーマニュアルやガイドを改善します。 -6. **コミュニティの参加**：ディスカッションに参加し、ユーザーを支援します。 -7. **使用の促進**：Cherry Studio を広めます。 +1. **コードの貢献**：新機能を開発するか、既存のコードを最適化します +2. **バグの修正**：見つけたバグを修正します +3. **問題の管理**：GitHub の問題を管理するのを手伝います +4. **製品デザイン**：デザインの議論に参加します +5. **ドキュメントの作成**：ユーザーマニュアルやガイドを改善します +6. **コミュニティの参加**：ディスカッションに参加し、ユーザーを支援します +7. **使用の促進**：Cherry Studio を広めます ## 始め方 -1. **リポジトリをフォーク**：フォークしてローカルマシンにクローンします。 -2. **ブランチを作成**：変更のためのブランチを作成します。 -3. **変更を提出**：変更をコミットしてプッシュします。 -4. **プルリクエストを開く**：変更内容と理由を説明します。 +1. **リポジトリをフォーク**：フォークしてローカルマシンにクローンします +2. **ブランチを作成**：変更のためのブランチを作成します +3. **変更を提出**：変更をコミットしてプッシュします +4. **プルリクエストを開く**：変更内容と理由を説明します 詳細なガイドラインについては、[貢献ガイド](../CONTRIBUTING.md)をご覧ください。 ご支援と貢献に感謝します！ -## 関連頁版 +## 関連プロジェクト - [one-api](https://github.com/songquanpeng/one-api)：LLM API の管理・配信システム。OpenAI、Azure、Anthropic などの主要モデルに対応し、統一 API インターフェースを提供。API キー管理と再配布に利用可能。 +- [ublacklist](https://github.com/iorate/ublacklist)：Google 検索結果から特定のサイトを非表示にします + # 🚀 コントリビューター - + +

-# コミュニティ +# 🌐 コミュニティ [Telegram](https://t.me/CherryStudioAI) | [Email](mailto:support@cherry-ai.com) | [Twitter](https://x.com/kangfenmao) -# スポンサー +# ☕ スポンサー -[Buy Me a Coffee](sponsor.md) +[開発者を支援する](sponsor.md) # 📃 ライセンス diff --git a/docs/README.zh.md b/docs/README.zh.md index 1e4876a820..ca85959dab 100644 --- a/docs/README.zh.md +++ b/docs/README.zh.md @@ -4,7 +4,8 @@

- English | 中文 | 日本語

+ English | 中文 | 日本語
+

kangfenmao%2Fcherry-studio | Trendshift Cherry Studio - AI Chatbots, AI Desktop Client | Product Hunt @@ -74,12 +75,12 @@ https://docs.cherry-ai.com - 📝 完整的 Markdown 渲染 - 🤲 便捷的内容分享功能 -# 📝 待辦事項 +# 📝 待办事项 - [x] 快捷弹窗（读取剪贴板、快速提问、解释、翻译、总结） - [x] 多模型回答对比 -- [x] 支持使用服务供应商提供的 SSO 进行登入 -- [x] 全部模型支持连网（开发中...） +- [x] 支持使用服务供应商提供的 SSO 进行登录 +- [x] 所有模型支持联网 - [x] 推出第一个正式版 - [x] 错误修复和改进（开发中...） - [ ] 插件功能（JavaScript） @@ -93,9 +94,9 @@ https://docs.cherry-ai.com - 主题库：https://cherrycss.com - Aero 主题：https://github.com/hakadao/CherryStudio-Aero -- PaperMaterial 主题: https://github.com/rainoffallingstar/CherryStudio-PaperMaterial -- 仿Claude 主题: https://github.com/bjl101501/CherryStudio-Claudestyle-dynamic -- 霓虹枫叶字体主题: https://github.com/BoningtonChen/CherryStudio_themes +- PaperMaterial 主题：https://github.com/rainoffallingstar/CherryStudio-PaperMaterial +- 仿 Claude 主题：https://github.com/bjl101501/CherryStudio-Claudestyle-dynamic +- 霓虹枫叶主题：https://github.com/BoningtonChen/CherryStudio_themes 欢迎 PR 更多主题 @@ -103,26 +104,30 @@ https://docs.cherry-ai.com 参考[开发文档](dev.md) +参考[架构概览文档](https://deepwiki.com/CherryHQ/cherry-studio) + +参考[分支策略](branching-strategy-zh.md)了解贡献指南 + # 🤝 贡献 我们欢迎对 Cherry Studio 的贡献！您可以通过以下方式贡献： -1. **贡献代码**：开发新功能或优化现有代码。 -2. **修复错误**：提交您发现的错误修复。 -3. **维护问题**：帮助管理 GitHub 问题。 -4. **产品设计**：参与设计讨论。 -5. **撰写文档**：改进用户手册和指南。 -6. **社区参与**：加入讨论并帮助用户。 -7. **推广使用**：宣传 Cherry Studio。 +1. **贡献代码**：开发新功能或优化现有代码 +2. **修复错误**：提交您发现的错误修复 +3. **维护问题**：帮助管理 GitHub 问题 +4. **产品设计**：参与设计讨论 +5. **撰写文档**：改进用户手册和指南 +6. **社区参与**：加入讨论并帮助用户 +7. **推广使用**：宣传 Cherry Studio ## 入门 -1. **Fork 仓库**：Fork 并克隆到您的本地机器。 -2. **创建分支**：为您的更改创建分支。 -3. **提交更改**：提交并推送您的更改。 -4. **打开 Pull Request**：描述您的更改和原因。 +1. **Fork 仓库**：Fork 并克隆到您的本地机器 +2. **创建分支**：为您的更改创建分支 +3. **提交更改**：提交并推送您的更改 +4. **打开 Pull Request**：描述您的更改和原因 -有关更详细的指南，请参阅我们的 [贡献指南](./CONTRIBUTING.zh.md)。 +有关更详细的指南，请参阅我们的 [贡献指南](./CONTRIBUTING.zh.md) 感谢您的支持和贡献！ @@ -130,10 +135,12 @@ https://docs.cherry-ai.com - [one-api](https://github.com/songquanpeng/one-api)：LLM API 管理及分发系统，支持 OpenAI、Azure、Anthropic 等主流模型，统一 API 接口，可用于密钥管理与二次分发。 +- [ublacklist](https://github.com/iorate/ublacklist)：屏蔽特定网站在 Google 搜索结果中显示 + # 🚀 贡献者 - +

@@ -143,7 +150,7 @@ https://docs.cherry-ai.com # ☕ 赞助 -[微信赞赏码](sponsor.md) +[赞助开发者](sponsor.md) # 📃 许可证 @@ -155,4 +162,4 @@ yinsenho@cherry-ai.com # ⭐️ Star 记录 -[![Star History Chart](https://api.star-history.com/svg?repos=kangfenmao/cherry-studio&type=Timeline)](https://star-history.com/#kangfenmao/cherry-studio&Timeline) \ No newline at end of file +[![Star History Chart](https://api.star-history.com/svg?repos=kangfenmao/cherry-studio&type=Timeline)](https://star-history.com/#kangfenmao/cherry-studio&Timeline) diff --git a/docs/branching-strategy-en.md b/docs/branching-strategy-en.md new file mode 100644 index 0000000000..f3b7ddf508 --- /dev/null +++ b/docs/branching-strategy-en.md @@ -0,0 +1,71 @@ +# 🌿 Branching Strategy + +Cherry Studio implements a structured branching strategy to maintain code quality and streamline the development process. + +## Main Branches + +- `main`: Main development branch + + - Contains the latest development code + - Direct commits are not allowed - changes must come through pull requests + - Code may contain features in development and might not be fully stable + +- `release/*`: Release branches + - Created from `main` branch + - Contains stable code ready for release + - Only accepts documentation updates and bug fixes + - Thoroughly tested before production deployment + +## Contributing Branches + +When contributing to Cherry Studio, please follow these guidelines: + +1. **Feature Branches:** + + - Create from `main` branch + - Naming format: `feature/issue-number-brief-description` + - Submit PR back to `main` + +2. **Bug Fix Branches:** + + - Create from `main` branch + - Naming format: `fix/issue-number-brief-description` + - Submit PR back to `main` + +3. **Documentation Branches:** + + - Create from `main` branch + - Naming format: `docs/brief-description` + - Submit PR back to `main` + +4. **Hotfix Branches:** + + - Create from `main` branch + - Naming format: `hotfix/issue-number-brief-description` + - Submit PR to both `main` and relevant `release` branches + +5. **Release Branches:** + - Create from `main` branch + - Naming format: `release/version-number` + - Used for final preparation work before version release + - Only accepts bug fixes and documentation updates + - After testing and preparation, merge back to `main` and tag with version + +## Workflow Diagram + +![](https://github.com/user-attachments/assets/61db64a2-fab1-4a16-8253-0c64c9df1a63) + +## Pull Request Guidelines + +- All PRs should be submitted to the `main` branch unless fixing a critical production issue +- Ensure your branch is up to date with the latest `main` changes before submitting +- Include relevant issue numbers in your PR description +- Make sure all tests pass and code meets our quality standards +- Add before/after screenshots if you add a new feature or modify a UI component + +## Version Tag Management + +- Major releases: v1.0.0, v2.0.0, etc. +- Feature releases: v1.1.0, v1.2.0, etc. +- Patch releases: v1.0.1, v1.0.2, etc. +- Hotfix releases: v1.0.1-hotfix, etc. diff --git a/docs/branching-strategy-zh.md b/docs/branching-strategy-zh.md new file mode 100644 index 0000000000..b1379537a5 --- /dev/null +++ b/docs/branching-strategy-zh.md @@ -0,0 +1,71 @@ +# 🌿 分支策略 + +Cherry Studio 采用结构化的分支策略来维护代码质量并简化开发流程。 + +## 主要分支 + +- `main`：主开发分支 + + - 包含最新的开发代码 + - 禁止直接提交 - 所有更改必须通过拉取请求（Pull Request） + - 此分支上的代码可能包含正在开发的功能，不一定完全稳定 + +- `release/*`：发布分支 + - 从 `main` 分支创建 + - 包含准备发布的稳定代码 + - 只接受文档更新和 bug 修复 + - 经过完整测试后可以发布到生产环境 + +## 贡献分支 + +在为 Cherry Studio 贡献代码时，请遵循以下准则： + +1. **功能开发分支：** + + - 从 `main` 分支创建 + - 命名格式：`feature/issue-number-brief-description` + - 完成后提交 PR 到 `main` 分支 + +2. **Bug 修复分支：** + + - 从 `main` 分支创建 + - 命名格式：`fix/issue-number-brief-description` + - 完成后提交 PR 到 `main` 分支 + +3. **文档更新分支：** + + - 从 `main` 分支创建 + - 命名格式：`docs/brief-description` + - 完成后提交 PR 到 `main` 分支 + +4. **紧急修复分支：** + + - 从 `main` 分支创建 + - 命名格式：`hotfix/issue-number-brief-description` + - 完成后需要同时合并到 `main` 和相关的 `release` 分支 + +5. **发布分支：** + - 从 `main` 分支创建 + - 命名格式：`release/version-number` + - 用于版本发布前的最终准备工作 + - 只允许合并 bug 修复和文档更新 + - 完成测试和准备工作后，将代码合并回 `main` 分支并打上版本标签 + +## 工作流程 + +![](https://github.com/user-attachments/assets/61db64a2-fab1-4a16-8253-0c64c9df1a63) + +## 拉取请求（PR）指南 + +- 除非是修复生产环境的关键问题，否则所有 PR 都应该提交到 `main` 分支 +- 提交 PR 前确保你的分支已经同步了最新的 `main` 分支内容 +- 在 PR 描述中包含相关的 issue 编号 +- 确保所有测试通过，且代码符合我们的质量标准 +- 如果你添加了新功能或修改了 UI 组件，请附上更改前后的截图 + +## 版本标签管理 + +- 主要版本发布：v1.0.0、v2.0.0 等 +- 功能更新发布：v1.1.0、v1.2.0 等 +- 补丁修复发布：v1.0.1、v1.0.2 等 +- 紧急修复发布：v1.0.1-hotfix 等 diff --git a/docs/branching-strategy.md b/docs/branching-strategy.md deleted file mode 100644 index 897763af16..0000000000 --- a/docs/branching-strategy.md +++ /dev/null @@ -1,52 +0,0 @@ -# 🌿 Branching Strategy - -Cherry Studio follows a structured branching strategy to maintain code quality and streamline the development process: - -## Main Branches - -- `main`: Production-ready branch containing stable releases - - - All code here is thoroughly tested and ready for production - - Direct commits are not allowed - changes must come through pull requests - - Each merge to main represents a new release - -- `develop` (default): Primary development branch - - Contains the latest delivered development changes for the next release - - Relatively stable but may contain features in progress - - This is the default branch for development - -## Contributing Branches - -When contributing to Cherry Studio, please follow these guidelines: - -1. **For bug fixes:** - - - Create a branch from `develop` - - Name format: `fix/issue-number-brief-description` - - Submit pull request back to `develop` - -2. **For new features:** - - - Create a branch from `develop` - - Name format: `feature/issue-number-brief-description` - - Submit pull request back to `develop` - -3. **For documentation:** - - - Create a branch from `develop` - - Name format: `docs/brief-description` - - Submit pull request back to `develop` - -4. **For critical hotfixes:** - - Create a branch from `main` - - Name format: `hotfix/issue-number-brief-description` - - Submit pull request to both `main` and `develop` - -## Pull Request Guidelines - -- Always create pull requests against the `develop` branch unless fixing a critical production issue -- Ensure your branch is up to date with the latest `develop` changes before submitting -- Include relevant issue numbers in your PR description -- Make sure all tests pass and code meets our quality standards -- Critical hotfixes may be submitted against `main` but must also be merged into `develop` -- Add a photo to show what is different if you add a new feature or modify a component in the UI.