《无名杀》项目 Pull Request 提交规范

《无名杀》项目 Pull Request 提交规范

编程风格与格式约定

1. 缩进规范

为了保证代码一致性及可读性，所有参与者在编写JavaScript代码时必须统一使用Tab字符进行缩进，禁止使用空格键代替。请预先配置好你的编辑器，确保其默认设置为每级缩进使用一个制表符。

2. 代码风格

请遵循ESLint或者项目内已有的代码风格规范，并确保在提交前运行lint工具进行检查并修正错误。

3. 提交信息

每次提交应附带清晰且有意义的提交信息，采用动词短语的形式，例如：“添加新功能 X” 或 “修复 issue #123: Bug description"。

分支管理与Pull Request流程

4. PR提交分支规定

所有的新功能、Bug修复以及其他代码变动都必须首先提交到名为 PR-Branch 的开发分支，不得直接提交到 master 主分支。

5. 文档与注释

• 新增方法需要JS Doc形式注释，标注每个参数以及返回值的作用。
• 若涉及到复杂的逻辑修改或新增功能，请尽可能提供设计思路、实现原理以及可能的影响分析。

6. 代码审查与讨论

• 耐心等待项目维护者或其他成员对您的PR进行审查，并积极回应审查中的提问和建议。
• 修改后的代码应当再次经过测试，并确保所有先前通过的测试依然能通过。

7. 合并

只有当PR得到至少一位项目维护者的批准，并通过检查后，该PR才会被合并到 PR-Branch。

---

遵循以上规范，我们能够更高效地协作，共同保障代码质量和项目的健康发展。再次感谢您对《无名杀》项目的贡献和支持！