Skip to content

Latest commit

 

History

History
38 lines (20 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

38 lines (20 loc) · 1.84 KB

Contributing to scblogs

想要成为 scblogs 的 Contributor? Welcome!

这个页面提供了一些 Tips ,可能对您的开发提供一些帮助。

开发环境准备

在项目的 document 文件夹下,有几个以 config 结尾的文件夹,里面是一些配置文件, 包括SQL、Nacos、代码样式等,并且有配套的说明文档。

其中必须进行操作的配置有:

  • idea_config:这份代码样式的配置文件将保障我们的代码风格是一致的

可选的配置有:

  • nacos_config:里面包含项目内所有保存在Nacos上的配置文件
  • mysql_config:里面包含项目内所有的数据库结构语句

Pull requests

首先,为了方便项目管理,请将您的 PR 推送至 dev 分支。

如果你对参与开源项目的流程还不太熟悉的话,建议你阅读一下这篇文章 论如何从0开始参与一个开源项目 ,里面有比较详细的参与过程介绍。

检查 issue 列表

不管您是已经明确了要提交什么代码,还是正在寻找一个想法,都应该先到 issue 列表看一下。 如果在 issue 中找到了感兴趣的,请在 issue 表明正在对这个 issue 进行开发。

社区准则

为了让社区保持强大,不断发展,我们向整个社区提出了一些通用准则:

友善:对社区成员保持尊重和礼貌。 请不要在社区中发布任何有关种族歧视、性别歧视、地域歧视、人格侮辱等言论。

鼓励参与:在社区中讲礼貌的每个人都应受到欢迎,无论他们的贡献程度如何, 我们鼓励一切人参与(不一定需要提交代码) scblogs 的开发。

紧贴主题:请避免主题外的讨论。当您更新或回复时,可能会给大量人员发送邮件, 请牢记,没有人喜欢垃圾邮件。