跳到主要内容

参与贡献

感谢你对译星者天文台指南的关注！这个网站还处于早期建设阶段，你看到的每一个页面都是社员们一点一点写出来的。

如果你发现错误、有更好的解释方式、或者有想写的选题——欢迎参与！

如何参与编辑​

我们推荐使用电脑进行编辑，手机或平板也可以，只是体验会差一些。进行任何编辑前你应该先登录 GitHub 账户，如果没有，可以点击这里注册。

如果你熟悉 Git，推荐 Fork 本仓库后在本地编辑，完成后向 master 分支提交 Pull Request，社团人员会审核你的修改。

关于写作格式​

所有文档都使用 Markdown 格式编写。如果你之前没用过 Markdown，请花 10 分钟读一下以下入门教程：

本项目还支持一些 Docusaurus 特有的扩展语法：

  • 提示框：用 :::note、:::tip、:::info、:::warning、:::danger 可以创建不同样式的提示框，详见 告示文档
  • 数学公式：用 $...$ 写行内公式（如 E=mc2E = mc^2），用 $$...$$ 写独立公式块，可以使用LaTeX语法。你可以查看KaTeX文档或KaTex语法笔记 | 礁石图书馆来学习
  • Mermaid 图表：可以直接在文档中画流程图、时序图等，详见 Mermaid 文档
  • 更多参考
提示

不用太担心写错——提交后社团审核时会帮你修正格式问题。

编辑已有页面​

  1. 找到你想改的页面 在网站上打开目标页面，点击页面底部左下角的 「编辑此页」，会跳转到 GitHub 的在线编辑器。

  2. 在线编辑 在 GitHub 编辑器中使用 Markdown 语法修改内容——编辑器左上角有 Preview 按钮可以实时预览，不需要安装任何软件。

  3. 提交修改

    • 点击右上角的 Commit changes 按钮，然后填写以下栏目：
      • Commit message（必填）：写一句话概括你改了什么，例如「修正赤道仪对极轴步骤的描述」
      • Extended description（可选）：补充更多细节、署名、或说明编辑的理由等
    • 点击 Propose changes
    • 跳转后点击 Create pull request

  4. 等待审核 社团人员会审核你的提交，通过后你的修改就会出现在网站上，你的名字也会出现在贡献者名单里 📝

新建文档​

  1. 如果你想写一篇全新的文档，可以点击下面的链接创建文件：

    新建理论文档

    新建设备文档

  2. 打开链接后，在编辑器上方的Name your file...中填写文件名（例如 行星冲日观测.md），用 Markdown 写好内容

  3. 提交修改

    • 点击右上角的 Commit changes 按钮，然后填写以下栏目：
      • Commit message（必填）：写一句话概括你改了什么，例如「新增行星冲日观测指南」
      • Extended description（可选）：补充更多细节、署名、或说明编辑的理由等
    • 点击 Propose changes
    • 跳转后点击 Create pull request

  4. 等待审核 社团人员会审核你的提交，通过后你的修改就会出现在网站上，你的名字也会出现在贡献者名单里 📝

提交规范​

本项目要求所有 commit 遵循 约定式提交 规范。

格式​

<类型>[可选 范围]: <描述>

[可选 正文]

[可选 脚注]

类型​

类型说明
feat新增功能（对应 SemVer MINOR）
fix修复 bug（对应 SemVer PATCH）
build修改项目构建系统，例如修改依赖库、外部接口或者升级 Node 版本等
chore对非业务性代码进行修改，例如修改构建流程或者工具配置等
ci修改持续集成流程，例如修改 CI/CD 工作流配置等
docs修改文档，例如修改 README 文件、API 文档等
style修改代码样式，例如调整缩进、空格、空行等
refactor重构代码，例如修改代码结构、变量名、函数名等但不修改功能逻辑
perf优化性能，例如提升代码的性能、减少内存占用等
test修改测试用例，例如添加、删除、修改代码的测试用例等
revert回滚之前的提交

破坏性变更在类型/范围后加 !，或在脚注中标注 BREAKING CHANGE:。

示例​

git commit -m "docs: 修正对极轴步骤的描述"
git commit -m "feat(equipment): 新增行星冲日观测指南"
git commit -m "fix: 修正梅西耶星表图片链接"
git commit -m "feat!: 重构 API 接口

BREAKING CHANGE: 原有 /v1/ 端点已升级为 /v2/"

自动检查​

项目配置了 commitlint + Husky，git commit 时自动校验消息格式。格式错误会提示原因并拒绝提交。

协作者执行 npm install 后自动生效，无需额外配置。

本文贡献者
TAHAamaBOTTAHAamaBOT