Merge pull request #270 from Teingi/2.3.0_readme

文档中增加开发者指引

README-CN.md

@@ -85,18 +85,48 @@ obdiag 期望构建一个开放的社区，我们欢迎任何形式的贡献，
 |3.2.0|2024.11| - |<ul><li> 根因分析场景扩展 </li><li> SQL 诊断二期，支持SQL问题的根因分析 </li></ul>|
 |3.3.0|2024.12| - |<ul><li> AI 化探索 </li></ul>|
 
-
-# 许可证
-
-OceanBase Diagnostic Tool 使用 [MulanPSL - 2.0](https://license.coscl.org.cn/MulanPSL2) 许可证。
-您可以免费复制及使用源代码。当您修改或分发源代码时，请遵守木兰协议。
-
 # 支持
 
 如果您在使用 OceanBase LogProxy 时遇到任何问题，欢迎联系我们寻求帮助：
 
 - [GitHub Issue](https://github.com/oceanbase/obdiag/issues)
 - [官方网站](https://www.oceanbase.com/docs/obdiag-cn)
 
-# 加入我们
-请添加 OB社区小助手（微信号：obce666）并备注“obdiag SIG”，工作人员会联系并指引您加入 SIG 的相关事宜。期待您的积极参与与宝贵贡献！
+# 开发者专区
+
+## 加入我们
+请添加 OB社区小助手（微信号：obce666）并备注“obdiag SIG”，工作人员会联系并指引您加入 SIG 的相关事宜。期待您的积极参与与宝贵贡献！
+
+## 开发者行动指南
+
+1. Fork并克隆你的专属副本：在我们的GitHub仓库页面右上角点击“Fork”按钮，这样就在你的账号下创建了一份仓库副本。接下来，使用Git命令将这份副本克隆到你的本地计算机上：
+
+```bash
+git clone https://github.com/your_username/your_repo_here.git
+```
+
+2. 修改代码：无论是修正漏洞还是增添新功能，你的每一份贡献都至关重要。
+
+3. 通过 black 工具统一格式化你的代码 🎨
+
+```bash
+black -S -l 256 {source_file_or_directory}
+```
+
+4. 提交你的改动：完成优化后，利用Git提交你的修改。
+
+5. 推送到你的Fork仓库：将你的改动推送到GitHub上的Fork仓库中。
+
+6. 发起合并请求（PR）：回到你的GitHub分叉页面，点击“Open pull request”按钮。对比你的分支与原始仓库的主分支，描述你的改动内容，然后提交PR！
+
+7. 🚀 自动化流程接棒此处 🤖
+
+接下来，就交给我们的GitHub Actions流水线：
+- 代码检查：PR一旦触发，流水线会自动代码格式化检查以及安全检查。
+- 自动构建：PR一旦触发，就会自动将你的改动编译成RPM和DEB两种软件包。
+
+
+# 许可证
+
+OceanBase Diagnostic Tool 使用 [MulanPSL - 2.0](https://license.coscl.org.cn/MulanPSL2) 许可证。
+您可以免费复制及使用源代码。当您修改或分发源代码时，请遵守木兰协议。

README.md

@@ -89,17 +89,50 @@ obdiag envisions an open community. We welcome your contributions in any form:
 |3.2.0|2024.11| - |<ul><li> Root Cause Analysis Scenario Expansion </li><li> SQL Diagnosis Phase II, Supporting Root Cause Analysis for SQL problems </li></ul>|
 |3.3.0|2024.12| - |<ul><li> AI for obdiag </li></ul>|
 
-# Licencing
-OceanBase Database is under MulanPubL - 2.0 license. You can freely copy and use the source code. When you modify or
-distribute the source code, please obey the MulanPubL - 2.0 license.
-
 # Support
 
 In case you have any problems when using obdiag, welcome reach out for help:
 
 - [GitHub Issue](https://github.com/oceanbase/obdiag/issues)
 - [Official Website](https://www.oceanbase.com/docs/obdiag-cn)
 
-# Join us
+# Developer
+
+## Join us
 Please add the OB community assistant (WeChat ID: obce666) and note "obdiag SIG", and the staff will contact you and guide you on matters related to joining SIG. We look forward to your active participation and valuable contributions!
 
+## 🚀 Contribute Smoothly: Fork, Enhance & Let Automation Work Its Magic! 🚀
+
+Hey there, fellow developer! Want to be a part of our exciting project and streamline the code? Here's your step-by-step guide to making an impact:
+
+1. Fork & Clone Your Personal Copy: Start by clicking the "Fork" button on the top right corner of our GitHub repository. This creates a copy of the project under your account. Next, clone this forked repository to your local machine using Git:
+
+```bash
+git clone https://github.com/your_username/your_repo_here.git
+```
+
+2. Make Your Magic Happen: Navigate to the cloned directory and start hacking away! Whether you're fixing bugs or adding innovative features, your contributions are invaluable.
+
+3. Format your code with black tool 🎨
+
+```bash
+black -S -l 256 {source_file_or_directory}
+```
+
+4. Commit Your Changes: Once you've made your enhancements, commit them using Git.
+
+5. Push to Your Fork: Push your changes back to your GitHub fork.
+
+6. Open a Pull Request (PR): Head back to your fork on GitHub and click the 'New pull request' button. Compare your branch against the original repository's master/main branch, write a clear description of your changes, and submit that PR!
+
+7. 🚀 Where Automation Kicks In 🤖
+
+From here on, sit back as our GitHub Actions workflow takes over:
+
+- Automated Build: Our carefully crafted workflow will automatically trigger, compiling your changes into both RPM and DEB packages.
+- Quality Assurance: It doesn't stop at compilation; tests are also run to ensure the integrity of the build and your code's compatibility.
+
+
+# Licencing
+OceanBase Database is under MulanPubL - 2.0 license. You can freely copy and use the source code. When you modify or
+distribute the source code, please obey the MulanPubL - 2.0 license.