## Issue 提交 #### 对于贡献者在提 issue 前请确保满足一下条件： - 必须是一个 bug 或者功能新增。 - 已经在 issue 中搜索过，并且没有找到相似的 issue 或者解决方案。 ## Pull request 我们除了希望听到您的反馈和建议外，我们也希望您接受代码形式的直接帮助，对我们的 GitHub 发出 pull request 请求。以下是具体步骤： #### Fork仓库点击 `Fork` 按钮，将需要参与的项目仓库 fork 到自己的 Github 中。 #### Clone 已 fork 项目在自己的 github 中，找到 fork 下来的项目，git clone 到本地。 ```bash $ git clone git@github.com:/tmagic-editor.git ``` #### 添加 tmagic-editor 仓库将 fork 源仓库连接到本地仓库： ```bash $ git remote add # 例如： $ git remote add tmagic git@github.com:Tencent/tmagic-editor.git ``` #### 保持与 tmagic-editor 仓库的同步更新上游仓库： ```bash $ git pull --rebase # 等同于以下两条命令 $ git fetch $ git rebase / ``` ## Commit 对于如何提交 git commit message，我们有非常精确的规则。我们希望所有的 commit message 更具可读性，这样在查看项目历史记录会变得容易，同时我们使用 commit message 生成 Changelog. 本项目使用了 `@commitlint` 作为 commit lint 工具，并使用 [`@commitlint/config-angular`](https://www.npmjs.com/package/@commitlint/config-angular)作为基础规则，请使用下面任意一种方式提交你的 commit. - 全局安装 `npm install -g commitizen`，然后使用 `cz` 提交 - 使用 `git commit -a` 提交，请注意 message 符合我们的要求 ### 提交格式每个 commit message 包括 **header**, **body** 和 **footer**. header 具有特殊的格式，包括 **type**, **scope** 和 **subject**, type 和 subject 是必须的，scope 是可选的。 ```vim ():