Skip to content
This repository has been archived by the owner on Mar 23, 2023. It is now read-only.

Latest commit

 

History

History
31 lines (16 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

31 lines (16 loc) · 1.58 KB

贡献指南

开发者在编写文档与程序的过程中,由于各种原因在文档描述中或代码中引入意外的错误或隐患,这是难以避免的。

报告问题

如果您发现其中的问题,并想告诉我们,建议您进行以下操做步骤:

  1. 在议题面板中,新建问题 Issue,标题尽可能简短并高度抽象问题的核心关键词。
  2. 在问题描述中,经可能详尽的描述问题的各个信息,包括但不局限于问题出现的文档/代码版本、问题的位置、使用者的系统环境、问题是否可复现、问题触发概率以及修改意见等。

主动修复

如果您发现其中的问题,并知道问题的解决方法,又有充足的行动力、丰富的经验,欢迎您向我们提交贡献,您可以经可能的修复问题并提交给我们,我们会评估您的行为和质量,若符合条件,我们将会采纳您的意见。具体步骤如下:

如果您是开发者

这里的开发者指的是您具有本项目的开发者权限(可以新建分支,提交等操作,但对于保护分支而无能为力):

  1. 报告问题中的描述一致,先将问题表述清楚,并从中创建对应的修复分支
  2. 在修复分支中修复问题完毕后,尝试提交和并请求。

如果您是访客/报告者

这意味着您无任何分支的创建/提交权限:

  1. 报告问题中的描述一致,先将问题表述清楚,Fork 以派生镜像项目。
  2. 在派生的镜像项目中修复问题完毕后,尝试提交和并请求。