跳转至

贡献指南

感谢你来到本页面——这说明你是一个有奉献精神的人。本网站是由众多志愿者一起义务运营的，但仅凭目前的人手还不足以支撑我们的日常维护和内容产出。我们希望有更多愿意贡献自己知识和技术的志愿者加入我们。

在正式参与之前，你需要了解这些东西。

贡献范围

你可以对本站所有内容作出贡献，包括但不限于：编写和编辑文档、代码贡献、内容审查、外语翻译工作、设计贡献、网站维护、文档格式化、web前端开发。

在开源社区，每个成员的贡献都是独一无二的，无论大小。通过共同努力，我们可以创造出更加强大、更有影响力的项目。记住，你的每一分努力都是推动项目前进的动力。

Warning

本站所有内容均遵照CC BY-NC 4.0协议开源，故若为此网站作出贡献，则默认所贡献的内容也以相同协议开源。

质量标准

在进行贡献之前，请确保你了解如何使用Markdown。这并不代表你需要精通Markdown这种标记语言。你只需要了解一些Markdown的特性与一些常用的语法。学习Markdown的基本用法通常只需要花费不到半小时。（Markdown扫盲)

文档具体的格式要求，请参看格式手册。

同时，为了让本站有意义，你的内容应符合以下标准：

  • 准确性：请确保贡献的内容在事实上是准确无误的，避免误导读者。
  • 清晰性：你的文档应当语言清晰、条理分明，逻辑性强，便于读者理解。
  • 文档风格：文档应排版适当、可读性强。文档中可能使用的格式包括但不限于：标题、LaTeX公式。
  • 完整性：贡献的内容应尽可能全面，涵盖相关主题的所有重要方面。
  • 最新性：信息应保持最新，及时更新过时的内容。
  • 技术规范：对于代码贡献，应遵循项目的技术规范和编码标准。
  • 版权合规：所有贡献的内容都应遵守版权法规，不侵犯他人的知识产权。
  • 引用和参考：对于引用的内容，应提供准确的来源和参考文献。
  • 语言和文化敏感性：避免使用可能引起误解或冒犯的语言和图像。

贡献方式

在确认好你的内容符合规范之后，你就可以正式作出贡献了。这里提供了几种可能的贡献方式。

在 GitHub 上编辑

参与 Starship 的编写 需要 一个 GitHub 账号（可以前往 GitHub 的账号注册页面 页面注册），但 不需要 高超的 GitHub 技巧，即使你是一名新手，只要按照下面所述的步骤操作，也能够 非常出色 地完成编辑。

Tip

在你的更改被合并到 Starship 的主仓库之前，你对 Starship 的内容所作出的修改均不会出现在 Starship 的主站上，所以无需担心你的修改会破坏 Starship 上正在显示的内容。

如果还是不放心，可以查看 GitHub 的官方教程。

  1. 在 Starship 上找到对应页面；
  2. 点击正文右上方（目录左侧）的「编辑此页」按钮，在确认您已经阅读了本页面和 格式手册 后点击按钮根据提示跳转到 GitHub 进行编辑；
  3. 在编辑框内编写你想修改的内容。请注意，在修改和接下来的提交过程中，请 关闭您的自动翻译软件，因为它可能产生不必要的麻烦（例如您修改的文件有时会被其错误改名，从而影响目录结构）；
  4. 编写完成后滚动到页面下方，按照本文中commit 信息格式规范填写 commit 信息，之后点击 Propose changes 按钮提交修改。点击按钮后，GitHub 会自动帮你创建一份 Starship 仓库的分支，并将你的提交添加到这个分支仓库。
  5. GitHub 会自动跳转到你的分支仓库的页面，此时页面上方会显示一个绿色的 Create pull request 按钮，点击后 GitHub 会跳转到一个创建 Pull Request 页面。向下滚动检查自己所作出的修改没有错误后，按照本文中Pull Request 信息格式规范一节中的规范书写 Pull Request 信息，然后点击页面上的绿色的 Create pull request 按钮创建一个新的PR。
  6. 不出意外的话，你的 Pull Request 就顺利提交到仓库，等待管理员审核并合并到主仓库中即可。

Commit 信息格式规范

对于提交时需要填写的 commit 信息，请遵守以下几点基本要求：

  1. commit 摘要请简要描述这一次 commit 改动的内容。注意 commit 摘要的长度不要超过 50 字符，超出的部分会自动置于正文中。
  2. 如果需要进一步描述本次 commit 内容，请在正文中详细说明。

对于 commit 摘要，推荐按照如下格式书写：

<修改类型>(<文件名>): <修改的内容>

修改类型分为如下几类：

  • feat：用于添加内容的情况。
  • fix：用于修正现有内容错误的情况。
  • refactor：用于对一个页面进行重构（较大规模的更改）的情况。
  • revert：用于回退之前更改的情况。

Pull Request 信息格式规范

对于 Pull Request，请遵守以下几点要求：

  1. 标题请写明本次 PR 的目的（做了 什么 工作，修复了 什么 问题）。
  2. 内容请简要叙述修改的内容。如果修复了一个 issue 的问题，请在内容中添加 fix #xxxx 字段，其中 xxxx 代表 issue 的编号。

对于 Pull Request 的标题，推荐使用如下格式书写：

<修改类型>(<文件名>): <修改的内容> (<对应 issue 的编号>)

修改类型分为如下几类：

  • feat：用于添加内容的情况。
  • fix：用于修正现有内容错误的情况。
  • refactor：用于对一个页面进行重构（较大规模的更改）的情况。
  • revert：用于回退之前更改的情况。

示例：

  • fix(ds/persistent-seg): 修改代码注释使描述更清晰
  • fix: tools/judger/index 不在目录中 (#3709)
  • feat(math/poly/fft): better proof
  • refactor(ds/stack): 整理页面内容

在GitHub中提起Issues

你可以通过Issues提出文档改进的建议，或者讨论更复杂的编辑事宜。

本地编辑

如果你实在不会使用GitHub，你可以使用本地编辑的形式。你可以在本地使用文本编辑器（例如：NotePad++，typora）撰写文档。编辑完成后，你可以通过邮件的方式将markdown文档发送给管理员（点击这里向管理员发送邮件，如果浏览器或系统不支持mailto命令，可以手动复制地址hownotfound@gmail.com）。请注意，请在发送邮件的同时，附带上你的身份信息（可以是实名、也可以是虚拟的身份），以便我们在文章中署名。

校园张贴栏

如果你的学校有Starship的文稿收集志愿者，那么你甚至可以在校园张贴栏发表你的文章。如果我们的文稿收集志愿者看到了你的文章，会收录你的文章并在文章下方留下提示。

请注意，如果你想通过这种方式发表文章，请你一定记得在文章开头留下我们网站的名字和网址，以便志愿者进行识别。请在张贴的同时，留下你的身份信息（可以是实名、也可以是虚拟的身份），以便我们在文章中署名。

目前支持：绵阳东辰学校弘毅楼、绵阳东辰高中广雅楼。

加入我们的讨论群

你可以加入我们的QQ讨论群959888475。你可以和群里的志愿者们一起讨论，也可以通过群聊联系管理员提交你的内容。

通过各种媒介宣传我们的网站

你可以通过社交媒体、博客、内容营销、口头推荐甚至校园公告栏的形式帮助宣传我们的网站。这对于吸引更多用户和志愿者加入社区有着巨大的作用。

都看到这里了，还不赶紧行动起来。

- The End -