贡献指南
约 706 个字 预计阅读时间 2 分钟
首先,感谢您抽出宝贵时间做出贡献!
所有类型的贡献都是值得鼓励和重视的。请参阅下面的内容,了解不同的贡献方式及如何处理它们的详细信息。请务必在贡献前阅读相关部分,这将使我们的维护人员更容易,并使所有相关人员的体验更加顺畅。我们期待您的贡献!
特别注意
在为本项目做出贡献时,您必须同意您创作了 100% 的内容,您对内容拥有必要的权利,并且您贡献的内容可以在项目许可下提供。
一、评论或建议¶
1.1 评论¶
如果你有什么问题等,你可以在评论区进行评论。比如你可以做出关于某部分内容的评述,然后与别人或者项目维护者进行相关的讨论,我们有可能会根据讨论结果对项目进行相关改进,当然,也可能不会采纳相关建议。
评论可以在我们允许评论的页面上提出,某些页面我们设置其不可评论。
1.2 建议¶
建议也是以评论的方式出现的,不过,建议应是在专门的页面下进行评论,而不是随便哪个页面下都可以提建议的。
建议应在建议区页面下提出,以评论的方式是为了保留建议的相关信息(如提出者、提出时间)。
二、编辑页面¶
2.1 源代码¶
- 必须保证能在最新稳定版本的编程环境下稳定运行;
- 内容必须与项目相关;
- 代码风格符合要求;
- 包含适当的注释;
- 无歧视性的内容;
2.2 其它内容¶
- 准确、无错字;
- 无歧视性的内容;
- 与对应页面内容相关;
2.3 风格指南¶
如果你想要你的 PR 被合并,我们希望你的代码风格尽量符合对应编程语言官方的风格,如果可以,我们更希望你的代码可以符合本项目的代码风格。
文本风格不做过多要求,尽可能丰富你的文本格式就好。
三、加入我们¶
如果你想加入我们,请联系项目团队的维护人员,下面是联系方式:
- 作者邮箱: 2951256653@qq.com
- 合作者 1: …
- 合作者 2: …
注:这个贡献指南是基于 https://contributing.md/example/ 改写的。