/doc

The public documents by the NiX team

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

NiX 团队公开文档

本项目为 NiX 团队所有可公开的文档,旨在使用 Git 更方便地管理和维护文档。请维护者自觉遵守相关的编辑规范。

欢迎大家为文档提供修改意见,请直接提交 Issue 或者 Pull Request,并且在相关贡献者清单中加上你的名字,添加 CHANGELOG。请遵守相关知识共享协议!

目录

钩子的安装和使用

  • 请在将项目克隆至本地之后执行 make hooks 安装 commit 信息检查钩子,目前 Windows 平台暂不支持钩子。
  • 为了方便文档管理,commit 信息的格式要求为文档名 v版本号 其他信息,其中文档名为 Markdown 文档第一行的一级标题名,版本号为数字和点符号的任意组合,其他信息可以为空。
  • 钩子禁止多 Markdown 文档同时提交,钩子信息检查会自动忽略 README 文档。
  • 如果你想忽略钩子的格式检查,请在执行 git commit 时加上 --no-verify 参数。

新建文档模版

  • 调用 make temp 并输入相关信息会在 docs 目录下生成一个文档模版。
  • 程序会优先检查 Git 的邮箱配置,如果没有配置邮箱,则需要手动输入。