如何贡献

欢迎

欢迎来到 OSPO 贡献指南,感谢您的关注。 您可以通过多种方式对本项目进行贡献,我们在此详细说明:

  1. 最佳实践
  2. 风格指南
  3. 处理现有疑修
  4. 提出新的术语

OSPO 术语表概览

这个术语表的目标是简化开源办公室领域的内容,从而使更多人能够轻松使用。

开源办公室术语表存储在这个 GitHub 仓库中。您可以在这里找到疑修和拉取请求(PRs)的列表。

谁可以贡献?

您参与这个项目的方式取决于您在开源办公室/组织内开源的专业水平。 简化复杂概念需要对其有深刻的理解。 因此,要贡献新术语,您必须对其很擅长。

专业知识是不可或缺的,因为凭借简单的词汇解释复杂的概念 非常 难。尽管产出易于理解、对用户友好的内容看似简单,然而达到这样的简洁度需要云原生专家的辛勤工作及协作。

如果您从未直接参与过开源办公室或组织内的开源倡议,但仍想参与贡献,我们建议您和那些有经验的人合作。 当专家认为术语准确地描述了概念,您就可以开始贡献了。

擅长其他语言的新手可以在本地化工作中为术语表做出宝贵贡献。 因为现有的英文术语足够可靠,贡献者即使缺乏经验也可以通过将术语翻译成目标语言进行贡献。您可以加入一个现成的本地化团队或创立一个新的。请阅读指南中帮助对术语表进行本地化的章节来了解如何开始。

在您开始之前

在您成为术语表的贡献者之前,请确认已经完成了如下步骤:

  1. 如果您还没有Github账户,请创建一个。

  2. 进行贡献的时候要熟悉DCO签名

最佳实践

为方便审阅,请使用语义换行(例如,每句一行)。 我们建议查看此markdown 备忘单 以正确格式化 GitHub 中的 Markdown 文本(如超链接、加粗、斜体)。 在命名 .md 文件时,请使用小写字母和连字符代替空格来分隔单词,并避免使用括号。

风格指南

通过阅读我们的风格指南来了解我们对格式化、文档协作以及让贡献过程更高效的指南。

处理已有疑修

术语表的GitHub仓库疑修中找到待处理的疑修。 你可以使用标签(例如,英文语言、需要帮助、适合入门)来过滤疑修。

注意:您可以在维护者将疑修分配给你之后开始工作。 您一次只能认领一个术语。 处理多个术语是依次进行的,您只有在完成一个术语后才能认领下一个。

提出新的术语

您可以提出一个新术语让他人研究,或者自己创建一个新定义。 无论如何,您都将从创建疑修开始。

我们根据好文档项目的模板更新了本指南。