Skip to content

贡献指南

Jump to bottom
Keldos edited this page Mar 7, 2023 · 7 revisions

感谢您对 Typora LaTeX Theme 的关注！我们欢迎任何形式的贡献。

请注意：本项目对 git 历史进行了重大修改，使得当前 git 树与原始 git 树相比，在相当早期就产生了分叉。请下游开发者及时进行同步。

开始之前

在一切开始前，请您先检查您遇到的问题是否被某个 issue 提到过。如果您遇到了问题或希望新增功能，可以在 GitHub discussion 或 issue 中提出。

如果您具备一定能力，可以直接修改本项目的源代码，并提交 pull request 。下面的章节将会对这一过程展开具体介绍，请您务必在贡献前完整阅读以下内容。

克隆仓库

您可以将项目完整克隆到本地：

git clone https://github.com/Keldos-Li/typora-latex-theme.git

为了保护主分支，本项目的所有开发工作都是在 develop 及其相关分支上进行的。如果您想要做出贡献，建议您在 develop 分支上开展您的工作。

构建过程

安装依赖

在一切开始前，请保证您有一台装有类 Unix 操作系统的设备。如果您在用 macOS 或 Linux ，那么您可以正常进行开发；如果您在使用 Windows ，推荐您在 WSL 环境下进行开发。

本项目使用 Makefile 进行构建。这意味着您的设备上需要装有 make 。 此外，本项目使用了 SCSS ，因此您需要安装 sass 。 sass 官方目前建议开发者使用 Dart Sass ，这也是项目维护者们选用的 sass 版本；但如果您的本地有 node-sass ，也可以正常进行开发。

另外，由于 make 的特性，您本地仓库的路径不应当包含中文，否则会报错。

开始构建

# 我们默认您当前位于仓库的根目录
cd src
make

如果构建成功，您的目录中应当出现新的 latex-theme 文件夹，其中包含了将会发布到 release 中为不同平台发布准备的所有文件。

如果您只想构建某个特定平台的发布文件，您也可以在 make 后指定参数（windows、macos、linux、pandoc）。例如，您想构建一份仅针对 macOS 的样式主题文件，您可以使用：

make macos

作出贡献

在您为本项目编写代码时，请留意：

  1. 变量名要用英文，不要使用汉语拼音代替英文
  2. 缩进一定要合适

希望您在编写代码前，先大致阅读代码全文，简要理解本项目的代码风格，再开始您的工作。

提交贡献

在您 commit 和 pull request 前，请一定留意：

  • 本项目 commit message 的格式是有规范的。请您在 commit 时遵守这个规范。

  • 本项目的工作语言是中文和英文。同时，本项目 commit message 的全文和 pull request 的标题需要用英文撰写。您可以自由选用任何工作语言撰写其余内容。

  • 请您向 develop 分支提交 pull request，不要向主分支提交。

审核与合并

如果您提交了 pull request，那么本项目的管理员会对您的贡献进行审核。我们会向您及时沟通我们的审核结果，烦请您与我们进行沟通。

您的 pull request 一般会被以 squash merge 的方式合并。这意味着，您 pull request 中的所有 commit 会被压缩成一个 commit；您是这个 commit 的著作者 (author) ，而本项目的管理员是这个 commit 的提交者 (committer) 。这是出于精简性考虑——一个 pull request 往往具有一定的原子性，且在我们与您沟通的过程中，您可能回滚了一些您已作出的改动，而诸如此类的 commit 往往是冗余的。如果您不认可这一合并方式，请提前与我们沟通。

Clone this wiki locally