Dapp-Learning-DAO · jasonandjay · Oct 29, 2024 · Oct 26, 2024 · Oct 26, 2024
diff --git a/docs/dao-en.md b/docs/dao-en.md
@@ -1,13 +1,14 @@
 ## How to participate in
+
 - **Submit a PR or follow account 「Rebase Community」 and contribute a tech share, then add the maintainer WeChat (ID: Yanyanho126) to apply to join the group, or contact Harry directly (WeChat ID: LJYXZJ) to join the developer group**
-	- [Submit a PR text tutorial](https://github.com/BNineCoding/Dapp-Learning/blob/main/docs/Create_DApp-Learning_PR_Tutorial-en.md)
-	- [Submit a PR video tutorial](https://www.bilibili.com/video/BV1Bq4y1r7dx?spm_id_from=333.999.0.0)
+  - [Submit a PR text tutorial](https://github.com/BNineCoding/Dapp-Learning/blob/main/docs/Create_DApp-Learning_PR_Tutorial-en.md)
+  - [Submit a PR video tutorial](https://www.bilibili.com/video/BV1Bq4y1r7dx?spm_id_from=333.999.0.0)
 - Friends who share in the Rebase community can directly apply to join the group
-- Using the market development method, anyone can submit PR, **Modify only one reference link or document to join the group**, There is no need to complete the task 100% before submitting, Developers work together to help improve the project, You can add links and documentation here [Dapp-Learning-Arsenal](https://github.com/Dapp-Learning-DAO/Dapp-Learning-Arsenal)  
+- Using the market development method, anyone can submit PR, **Modify only one reference link or document to join the group**, There is no need to complete the task 100% before submitting, Developers work together to help improve the project, You can add links and documentation here [Dapp-Learning-Arsenal](https://github.com/Dapp-Learning-DAO/Dapp-Learning-Arsenal)
 - For each project readme, please be sure to add the directory of reference links and attach the relevant references of the task
 - solidity Version 0.6 or later is recommended
 - The test cases under the script directory can be successfully debugged on the Goerli network (recommended), and the test cases under the test directory can be successfully debugged even on the local node
-**A fledgling project，There are four ways to cut into learning：**
+  **A fledgling project，There are four ways to cut into learning：**
 
 1. You can optimize the previous project code and readme
 2. You can claim the unfinished task card (The links below are all unfinished quest cards, For the completed task card, please put the reference link under the corresponding project readme)
@@ -17,20 +18,40 @@
 In the developer group, I can have close communication with developers and participate in the Dapp research group to study DEFI, DAO, and other projects together.
 
 ## Group learning
-  Advanced tasks, such as DeFi, Dao, and NFT project research, adopt group learning mode and have the following requirements.
- 1. Developers who submit more than one PR can participate in the group study;
- 2. In principle, the subtask research of the team shall not exceed 3 people, and the team members shall have a clear division of labor and supervise each other;
- 3. Front end and graph are optional, White papers and smart contracts are mandatory;
- 4. In principle, it needs to be shared once a week, which can be postponed once.
 
- Study in groups and show results (reference)：    
- White paper/contract/front-end/GRAPH: Deployment, documentation and Rebase video sharing
+Advanced tasks, such as DeFi, Dao, and NFT project research, adopt group learning mode and have the following requirements.
 
+1.  Developers who submit more than one PR can participate in the group study;
+2.  In principle, the subtask research of the team shall not exceed 3 people, and the team members shall have a clear division of labor and supervise each other;
+3.  Front end and graph are optional, White papers and smart contracts are mandatory;
+4.  In principle, it needs to be shared once a week, which can be postponed once.
+
+Study in groups and show results (reference)：  
+ White paper/contract/front-end/GRAPH: Deployment, documentation and Rebase video sharing
 
 ## The DAO organization manages the project
-  1. If you have participated in PR(or tech sharing) once or more, you can join the developer group;
-  2. After submitting 3 copies of high-quality PR (or participating in 3 tasks), you can join the PR audit team and or obtain the authority to audit PR
-  3. PR reviewers can initiate study groups;
-  4. The PR reviewer can initiate a proposal, decide the project development plan, and obtain the consent of most PR reviewers to pass the proposal;
-  5. A PR reviewer must do a PR at least once within two weeks, otherwise remove the PR reviewer permission, demote to the normal developer, and re-join with PR;
-  6. In principle, weekly developer networking meetings.
+
+1. If you have participated in PR(or tech sharing) once or more, you can join the developer group;
+2. After submitting 3 copies of high-quality PR (or participating in 3 tasks), you can join the PR audit team and or obtain the authority to audit PR
+3. PR reviewers can initiate study groups;
+4. The PR reviewer can initiate a proposal, decide the project development plan, and obtain the consent of most PR reviewers to pass the proposal;
+5. A PR reviewer must do a PR at least once within two weeks, otherwise remove the PR reviewer permission, demote to the normal developer, and re-join with PR;
+6. In principle, weekly developer networking meetings.
+
+## Available PR Title Types
+
+eEnsuring the title follows a specific format helps us manage and review code more effectively, please refer to the available types below:
+
+- **feat**: A new feature
+- **fix**: A bug fix
+- **docs**: Documentation-only changes
+- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)
+- **refactor**: A code change that neither fixes a bug nor adds a feature
+- **perf**: A code change that improves performance
+- **test**: Adding missing tests or correcting existing tests
+- **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
+- **ci**: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
+- **chore**: Other changes that don't modify src or test files
+- **revert**: Reverts a previous commit
+
+Ensuring that your PR title is correctly formatted will help facilitate a smoother review process and avoid potential lint failures. Thank you for your cooperation and contributions!
diff --git a/docs/dao.md b/docs/dao.md
@@ -1,13 +1,15 @@
 中文 / [English](https://github.com/Dapp-Learning-DAO/Dapp-Learning/blob/main/docs/dao-en.md)
 
 ## 如何参与
-- 欢迎加入我们discord: https://discord.gg/ztpc6p2yAT  
+
+- 欢迎加入我们discord: https://discord.gg/ztpc6p2yAT
 - 提交三次PR 或 安排贡献一次技术分享即可加入开发群，然后添加Maintainer微信yanyanho126申请入群。
-	- [提交PR文字教程](https://github.com/BNineCoding/Dapp-Learning/blob/main/docs/Create_DApp-Learning_PR_Tutorial.md)
-	- [提交PR视频教程](https://www.bilibili.com/video/BV1Bq4y1r7dx?spm_id_from=333.999.0.0)
+
+  - [提交PR文字教程](https://github.com/BNineCoding/Dapp-Learning/blob/main/docs/Create_DApp-Learning_PR_Tutorial.md)
+  - [提交PR视频教程](https://www.bilibili.com/video/BV1Bq4y1r7dx?spm_id_from=333.999.0.0)
   - [Dapp-Learning分享时间安排](https://docs.qq.com/doc/DQ3hWeVVXQ3JPbXFS)
 
-- 采用集市开发方式，任何人都可以提交PR，**一个参考链接，一个文档修改**均可，无须task完成100%再提交，开发者会一起帮忙完善项目, 可在此添加链接和文档[Dapp-Learning-Arsenal](https://github.com/Dapp-Learning-DAO/Dapp-Learning-Arsenal)  
+- 采用集市开发方式，任何人都可以提交PR，**一个参考链接，一个文档修改**均可，无须task完成100%再提交，开发者会一起帮忙完善项目, 可在此添加链接和文档[Dapp-Learning-Arsenal](https://github.com/Dapp-Learning-DAO/Dapp-Learning-Arsenal)
 - 每个项目readme请务必加上参考链接这一目录，附上任务的相关参考资料
 - solidity 建议0.6以上版本
 - script脚本目录下测试案例保证能在Goerli网(建议)调试成功，test目录下测试案例连本地节点调试成功
@@ -17,25 +19,47 @@
 1. 可以优化之前的项目代码和readme
 2. 可以认领未完成任务卡（下方有链接的都是未完成任务卡，完成的任务卡请将参考链接放入对应项目readme下）
 3. 可以自由新增任务卡（需附上参考链接）
-4. 进阶项目（DEFI，DAO，NFT，CRYPTO）可以在群里发起开发倡议，小组一起研究  
+4. 进阶项目（DEFI，DAO，NFT，CRYPTO）可以在群里发起开发倡议，小组一起研究
 
 在开发者群里可以跟开发者近距离交流以及参与Dapp研究小组，一起研究DEFI，DAO等项目。
 
 ## 小组学习
-  进阶任务如defi，dao, nft项目研究，采用小组学习模式，有以下要求。
- 1. 提交3次PR以上的开发者方可参与小组学习；
- 2. 原则上小组的子任务研究不超过3个人，小组组员需分工明确，互相督促；
- 3. 前端和graph可选项， 白皮书和智能合约是必选项；
- 4. 分享时间原则上一周一次分享，可延期一次。 
 
- 小组学习输出成果（参考）：    
- 白皮书/合约/前端/graph： 部署，文档和rebase视频分享
+进阶任务如defi，dao, nft项目研究，采用小组学习模式，有以下要求。
 
+1.  提交3次PR以上的开发者方可参与小组学习；
+2.  原则上小组的子任务研究不超过3个人，小组组员需分工明确，互相督促；
+3.  前端和graph可选项， 白皮书和智能合约是必选项；
+4.  分享时间原则上一周一次分享，可延期一次。
+
+小组学习输出成果（参考）：  
+ 白皮书/合约/前端/graph： 部署，文档和rebase视频分享
 
 ## DAO组织管理项目
-  1. 项目有交流群和开发群，开发群严格控制120人数上限。
-  2. 贡献过3次PR（或技术分享）以上可以进入开发者群；  
-  3. 贡献过多次高质量PR（或参与3个task的完成）即可给予PR审核者的权限，进入PR审核者群；
-  4. PR审核者可以发起提案，决定项目发展规划，获取多数PR审核者同意即可通过提案；
-  5. PR审核者须两周内至少完成一次PR，否则移除PR审核者权限，降为普通开发者，可以提PR重新加入；
-  6. 原则上一周一次开发者沟通会议。
+
+1. 项目有交流群和开发群，开发群严格控制120人数上限。
+2. 贡献过3次PR（或技术分享）以上可以进入开发者群；
+3. 贡献过多次高质量PR（或参与3个task的完成）即可给予PR审核者的权限，进入PR审核者群；
+4. PR审核者可以发起提案，决定项目发展规划，获取多数PR审核者同意即可通过提案；
+5. PR审核者须两周内至少完成一次PR，否则移除PR审核者权限，降为普通开发者，可以提PR重新加入；
+6. 原则上一周一次开发者沟通会议。
+
+以下是经过调整后的内容，加入了背景信息以弱化 PR title lint 的强调，并说明其目的：
+
+## PR 标题可用类型
+
+确保标题符合特定格式可以帮助我们更好地管理和审核代码，请参考以下可用类型：
+
+- **feat**: 新功能
+- **fix**: 修复 bug
+- **docs**: 仅文档更改
+- **style**: 不影响代码含义的更改（如空格、格式、缺少分号等）
+- **refactor**: 不修复 bug 也不添加新功能的代码更改
+- **perf**: 改进性能的代码更改
+- **test**: 添加缺失的测试或修正现有测试
+- **build**: 影响构建系统或外部依赖的更改（例如：gulp, broccoli, npm）
+- **ci**: 对 CI 配置文件和脚本的更改（例如：Travis, Circle, BrowserStack, SauceLabs）
+- **chore**: 其他不修改 src 或测试文件的更改
+- **revert**: 撤销之前的提交
+
+确保 PR 标题格式正确将有助于顺利通过检查并加快审核过程。感谢你的配合与贡献！