Skip to content

Commit 4ff63dd

Browse files
add pr guide
1 parent 08b328e commit 4ff63dd

3 files changed

Lines changed: 27 additions & 3 deletions

File tree

src/developers/readme.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,19 @@ dev: WebGAL 开发版
2424

2525
为了帮助我们更好地理解和审核您的贡献,请您注意以下几点:
2626

27+
**提交 Pull Request 前的准备工作**
28+
29+
*先提交 Issue***在开始任何开发工作前,请先提交一个 Issue 来讨论您的想法和设计方案**。这有助于避免重复工作,确保您的贡献符合项目的方向,并避免 PR 因设计问题无法合并的情况。
30+
31+
*RFC(Request for Comments)*: 对于大型改动或新功能,建议先提交 RFC 或详细的设计提案,与维护者和社区成员讨论技术方案的可行性。
32+
33+
**代码质量要求**
34+
2735
*代码注释*: 为了方便我们理解您的代码思路,建议您在关键部分添加注释说明。
2836

2937
*功能测试*: 如果您添加或修改了功能,请提供相应的测试方法,以确保功能正常运行。如果您进行了代码重构,也请提供测试方法来覆盖受影响的范围,确保重构没有引入新的问题。
3038

31-
*清晰的说明*: 在提交 Pull Request 时,请简要说明您所做的改动以及背后的原因,这将有助于我们更快地理解您的贡献。
39+
*清晰的说明*: 在提交 Pull Request 时,请简要说明您所做的改动以及背后的原因,并引用相关的 Issue,这将有助于我们更快地理解您的贡献。
3240

3341
### 在本地启动 WebGAL 项目
3442

src/en/developers/readme.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,19 @@ If you wish to contribute to the WebGAL Terre visual editor, please refer to the
2424

2525
To help us better understand and review your contribution, please note the following:
2626

27+
**Pre-Pull Request Preparation:**
28+
29+
* **Submit an Issue First:** **Before starting any development work, please submit an Issue to discuss your ideas and design proposal**. This helps avoid duplicate work, ensures your contribution aligns with the project direction, and prevents PRs from being unable to merge due to design issues.
30+
31+
* **RFC (Request for Comments):** For major changes or new features, we recommend submitting an RFC or detailed design proposal first to discuss the feasibility of the technical approach with maintainers and community members.
32+
33+
**Code Quality Requirements:**
34+
2735
* **Code Comments:** To help us understand your code logic, we recommend adding comments to key sections.
2836

2937
* **Functional Testing:** If you add or modify functionality, please provide corresponding test methods to ensure the functionality works as expected. If you refactor code, please also provide test methods to cover the affected areas and ensure the refactoring does not introduce new issues.
3038

31-
* **Clear Explanation:** When submitting a Pull Request, please briefly describe the changes you made and the reasons behind them. This will help us understand your contribution more quickly.
39+
* **Clear Explanation:** When submitting a Pull Request, please briefly describe the changes you made and the reasons behind them, and reference the related Issue. This will help us understand your contribution more quickly.
3240

3341
### Starting the WebGAL Project Locally
3442

src/ja/developers/readme.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,19 @@ WebGAL Terre ビジュアルエディターに貢献したい場合は、[WebGAL
2424

2525
貢献内容をよりよく理解し、レビューするために、以下の点にご注意ください。
2626

27+
**プルリクエスト前の準備作業:**
28+
29+
* **先に Issue を提出:** **開発作業を開始する前に、アイデアと設計提案について議論するために Issue を提出してください**。これにより、重複作業を避け、貢献がプロジェクトの方向性と一致していることを確認し、設計上の問題で PR がマージできない状況を防ぐことができます。
30+
31+
* **RFC(Request for Comments):** 大規模な変更や新機能については、技術的アプローチの実現可能性について維持者やコミュニティメンバーと議論するために、まず RFC または詳細な設計提案を提出することをお勧めします。
32+
33+
**コード品質の要件:**
34+
2735
* **コードコメント:** コードロジックを理解しやすくするために、主要なセクションにコメントを追加することをお勧めします。
2836

2937
* **機能テスト:** 機能を追加または変更した場合は、機能が期待どおりに動作することを確認するための対応するテスト方法を提供してください。コードをリファクタリングした場合は、影響を受ける範囲をカバーし、リファクタリングによって新しい問題が発生しないことを確認するためのテスト方法も提供してください。
3038

31-
* **明確な説明:** プルリクエストを送信する際には、行った変更とその理由を簡単に説明してください。これにより、貢献内容をより迅速に理解することができます。
39+
* **明確な説明:** プルリクエストを送信する際には、行った変更とその理由を簡単に説明し、関連する Issue を参照してください。これにより、貢献内容をより迅速に理解することができます。
3240

3341
### ローカルで WebGAL プロジェクトを起動する
3442

0 commit comments

Comments
 (0)