同步操作将从 Tencent/tmagic-editor 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
在提 issue 前请确保满足一下条件:
我们除了希望听到您的反馈和建议外,我们也希望您接受代码形式的直接帮助,对我们的 GitHub 发出 pull request 请求。
以下是具体步骤:
点击 Fork
按钮,将需要参与的项目仓库 fork 到自己的 Github 中。
在自己的 github 中,找到 fork 下来的项目,git clone 到本地。
$ git clone git@github.com:<yourname>/tmagic-editor.git
将 fork 源仓库连接到本地仓库:
$ git remote add <name> <url>
# 例如:
$ git remote add tmagic git@github.com:Tencent/tmagic-editor.git
更新上游仓库:
$ git pull --rebase <name> <branch>
# 等同于以下两条命令
$ git fetch <name> <branch>
$ git rebase <name>/<branch>
对于如何提交 git commit message,我们有非常精确的规则。我们希望所有的 commit message 更具可读性,这样在查看项目历史记录会变得容易,同时我们使用 commit message 生成 Changelog.
本项目使用了 @commitlint
作为 commit lint 工具,并使用 @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 是可选的。
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
提交 message 的任何行不能超过 100 个字符!确保 message 在 GitHub 以及各种 git 工具中更易于阅读。
注脚应该包含 closing reference to an issue 如果有的话.
示例:
docs(changelog): update change log to beta.5
fix(editor): resize error
Component doesn't refresh when resize it.
fix #123
必须是以下选项之一:
Scope 应该是本次修改所影响模块的名称(文件夹名称或其他有意义的单词)。
<prefix:name>
<prefix:name1,name2>
其他情况可以忽略 scope:
docs
, build
或 ci
等全局修改(例如:docs: add missing type
).Subject 是本次修改的简洁描述:
Body 应包含修改的动机,并对比这与以前的行为,是本次修改的详细描述:
Footer 应包含 Breaking Changes 和关闭或关联的 Issues
BREAKING CHANGE:
开头fix #123
或者 re #123
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。