Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

28 lines (20 loc) · 1.54 KB

贡献指北

提交信息格式

提交信息应遵循 PJ568 提交说明规范

提交更改

  1. Fork 此仓库,对其进行更改,并检查语法是否存在任何问题。
  2. 向我的仓库提交合并请求。请确保您遵循了上述说明。
  3. 我将定期审查合并请求,并告知您我的问题以及在合并您的合并请求之前需要进行的任何更改。
  4. 我希望您在 15 日内作出回应,之后如果没有显示活动,您的合并请求可能会被关闭。

参考流程

  1. Fork 源码,下载到本地并运行项目;
  2. 添加或修改代码;
  3. 对相关改动进行全面的自我测试;
  4. 确认无误后提交修改到 Github;
  5. 提交合并请求。

注意事项

  • 单次合并请求不应提交过多修改,请确保每次提交都针对特定的功能且务必说明本次改动的具体目的,例如:修复某 bug 、优化某方法 等,方便进行 Code Review;
  • 对于 bug 的修复,应该将本次合并请求和相对应 bug 的 issue 关联起来,让别人知道该问题已经被修复;
  • 对于较大的新功能,你需要先提交 Issues,例如 “添加 XXX 功能”,确认该功能有被添加的必要后,再开始工作;
  • 对于一些主观的样式、交互逻辑调整:如颜色、图标的使用,某些预设配置的增减修改等,一般不予通过。但可以在 Discussions 中进行讨论;
  • 其他如简单的代码优化、文档修正等,只要修改合理都会被接受。