This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository
https://gitbox.apache.org/repos/asf/incubator-dolphinscheduler-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 43b0fdc Automated deployment: Fri Oct 23 08:02:16 UTC 2020
42d4fb42f31b29dedd6913fb93a55b87e6a9bf7e
43b0fdc is described below
commit 43b0fdc6c09f1c48a73f32fda0600595fb9ee919
Author: dailidong <[email protected]>
AuthorDate: Fri Oct 23 08:02:16 2020 +0000
Automated deployment: Fri Oct 23 08:02:16 UTC 2020
42d4fb42f31b29dedd6913fb93a55b87e6a9bf7e
---
build/documentation.js | 2 +-
en-us/docs/development/commit-message.html | 92 ++++++++++++++++++++++
en-us/docs/development/commit-message.json | 10 +++
.../{commit_message.html => commit-message.html} | 6 +-
.../{commit_message.json => commit-message.json} | 4 +-
5 files changed, 108 insertions(+), 6 deletions(-)
diff --git a/build/documentation.js b/build/documentation.js
index 8748a97..8071b68 100644
--- a/build/documentation.js
+++ b/build/documentation.js
@@ -174,4 +174,4 @@ Object.defineProperty(t,"__esModule",{value:!0});var
i="function"==typeof Symbol
* Copyright © 2012-2019 Faisal Salman <[email protected]>
* Licensed under MIT License
*/
-return"string"==typeof e?e.replace(/[^\d\.]/g,"").split(".")[0]:void
0},trim:function(e){return
e.replace(/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,"")}},m={rgx:function(e,t){for(var
n,r,o,i,a,c,s=0;s<t.length&&!a;){var
l=t[s],u=t[s+1];for(n=r=0;n<l.length&&!a;)if(a=l[n++].exec(e))for(o=0;o<u.length;o++)c=a[++r],i=u[o],"object"==typeof
i&&i.length>0?2==i.length?"function"==typeof
i[1]?this[i[0]]=i[1].call(this,c):this[i[0]]=i[1]:3==i.length?"function"!=typeof
i[1]||i[1].exec&&i[1].test?this[i [...]
\ No newline at end of file
+return"string"==typeof e?e.replace(/[^\d\.]/g,"").split(".")[0]:void
0},trim:function(e){return
e.replace(/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,"")}},m={rgx:function(e,t){for(var
n,r,o,i,a,c,s=0;s<t.length&&!a;){var
l=t[s],u=t[s+1];for(n=r=0;n<l.length&&!a;)if(a=l[n++].exec(e))for(o=0;o<u.length;o++)c=a[++r],i=u[o],"object"==typeof
i&&i.length>0?2==i.length?"function"==typeof
i[1]?this[i[0]]=i[1].call(this,c):this[i[0]]=i[1]:3==i.length?"function"!=typeof
i[1]||i[1].exec&&i[1].test?this[i [...]
\ No newline at end of file
diff --git a/en-us/docs/development/commit-message.html
b/en-us/docs/development/commit-message.html
new file mode 100644
index 0000000..256fc08
--- /dev/null
+++ b/en-us/docs/development/commit-message.html
@@ -0,0 +1,92 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+ <meta charset="UTF-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0,
maximum-scale=1.0, user-scalable=no">
+ <meta name="keywords" content="DolphinScheduler, commit message,
contibuting" />
+ <meta name="description" content="This documentation outlines the
commit message format for contributing to dolphine scheduler" />
+ <!-- 网页标签标题 -->
+ <title>Commit Message</title>
+ <link rel="shortcut icon" href="/img/docsite.ico"/>
+ <link rel="stylesheet" href="/build/documentation.css" />
+</head>
+<body>
+ <div id="root"><div class="documentation-page"
data-reactroot=""><header class="header-container header-container-normal"><div
class="header-body"><a href="/en-us/index.html"><img class="logo"
src="/img/hlogo_colorful.svg"/></a><div class="search search-normal"><span
class="icon-search"></span></div><span class="language-switch
language-switch-normal">中</span><div class="header-menu"><img
class="header-menu-toggle" src="/img/system/menu_gray.png"/><div><ul
class="ant-menu blackClass ant [...]
+<h3>Preface</h3>
+<p>A good commit message can help other developers (or future developers)
quickly understand the context of related changes, and can also help project
managers determine whether the commit is suitable for inclusion in the release.
But when we checked the commit logs of many open source projects, we found an
interesting problem. Some developers have very good code quality, but the
commit message record is rather confusing. When other contributors or learners
are viewing the code, it can’t [...]
+The purpose of the changes before and after the submission, as Peter Hutterer
said：Re-establishing the context of a piece of code is wasteful. We can’t avoid
it completely, so our efforts should go to reducing it as much as possible.
Commit messages can do exactly that and as a result, a commit message shows
whether a developer is a good collaborator. Therefore, DolphinScheduler
developed the protocol in conjunction with other communities and official
Apache documents.</p>
+<h3>Commit Message RIP</h3>
+<h4>1：Clearly modify the content</h4>
+<p>A commit message should clearly state what issues (bug fixes, function
enhancements, etc.) the submission solves, so that other developers can better
track the issues and clarify the optimization during the version iteration
process.</p>
+<h4>2：Associate the corresponding Pull Request or Issue</h4>
+<p>When our changes are large, the commit message should best be associated
with the relevant Issue or Pull Request on Github, so that our developers can
quickly understand the context of the code submission through the associated
information when reviewing the code. If the current commit is for an issue,
then the issue can be closed in the Footer section.</p>
+<h4>3：Unified format</h4>
+<p>The formatted CommitMessage can help provide more historical information
for quick browsing, and it can also generate a Change Log directly from
commit.</p>
+<p>Commit message should include three parts: Header, Body and Footer. Among
them, Header is required, Body and Footer can be omitted.</p>
+<h5>Header</h5>
+<p>The header part has only one line, including three fields: type (required),
scope (optional), and subject (required).</p>
+<p>[DS-ISSUE number][type] subject</p>
+<p>(1) Type is used to indicate the category of commit, and only the following
7 types are allowed.</p>
+<ul>
+<li>feat：New features</li>
+<li>fix：Bug fixes</li>
+<li>docs：Documentation</li>
+<li>style： Format (does not affect changes in code operation)</li>
+<li>refactor：Refactoring (It is not a new feature or a code change to fix a
bug)</li>
+<li>test：Add test</li>
+<li>chore：Changes in the build process or auxiliary tools</li>
+</ul>
+<p>If the type is feat and fix, the commit will definitely appear in the
change log. Other types (docs, chore, style, refactor, test) are not
recommended.</p>
+<p>(2) Scope</p>
+<p>Scope is used to indicate the scope of commit impact, such as server,
remote, etc. If there is no suitable scope, you can use *.</p>
+<p>(3) subject</p>
+<p>Subject is a short description of the purpose of the commit, no more than
50 characters.</p>
+<h5>Body</h5>
+<p>The body part is a detailed description of this commit, which can be
divided into multiple lines, and the line break will wrap with 72 characters to
avoid automatic line wrapping affecting the appearance.</p>
+<p>Note the following points in the Body section:</p>
+<ul>
+<li>
+<p>Use the verb-object structure, note the use of present tense. For example,
use change instead of changed or changes</p>
+</li>
+<li>
+<p>Don't capitalize the first letter</p>
+</li>
+<li>
+<p>The end of the sentence does not need a ‘.’ (period)</p>
+</li>
+</ul>
+<h5>Footer</h5>
+<p>Footer only works in two situations</p>
+<p>(1) Incompatible changes</p>
+<p>If the current code is not compatible with the previous version, the Footer
part starts with BREAKING CHANGE, followed by a description of the change, the
reason for the change, and the migration method.</p>
+<p>(2) Close Issue</p>
+<p>If the current commit is for a certain issue, you can close the issue in
the Footer section, or close multiple issues at once.</p>
+<h5>For Example</h5>
+<pre><code>[DS-001][docs-en] add commit message
+
+- commit message RIP
+- build some conventions
+- help the commit messages become clean and tidy
+- help developers and release managers better track issues
+ and clarify the optimization in the version iteration
+
+This closes #001
+</code></pre>
+<h3>Reference documents</h3>
+<p><a
href="https://cwiki.apache.org/confluence/display/GEODE/Commit+Message+Format";>Commit
message format</a></p>
+<p><a href="http://who-t.blogspot.com/2009/12/on-commit-messages.html";>On
commit messages-Peter Hutterer</a></p>
+<p><a href="https://mp.weixin.qq.com/s/LKM4IXAY-7dKhTzGu5-oug";>RocketMQ
Community Operation Conventions</a></p>
+</div></section><footer class="footer-container"><div class="footer-body"><img
src="/img/ds_gray.svg"/><div class="cols-container"><div class="col
col-12"><h3>Disclaimer</h3><p>Apache DolphinScheduler (incubating) is an effort
undergoing incubation at The Apache Software Foundation (ASF), sponsored by
Incubator.
+Incubation is required of all newly accepted projects until a further review
indicates
+that the infrastructure, communications, and decision making process have
stabilized in a manner consistent with other successful ASF projects.
+While incubation status is not necessarily a reflection of the completeness or
stability of the code,
+it does indicate that the project has yet to be fully endorsed by the
ASF.</p></div><div class="col col-6"><dl><dt>Documentation</dt><dd><a
href="/en-us/docs/development/architecture-design.html"
target="_self">Overview</a></dd><dd><a
href="/en-us/docs/1.2.0/user_doc/quick-start.html" target="_self">Quick
start</a></dd><dd><a href="/en-us/docs/development/backend-development.html"
target="_self">Developer guide</a></dd></dl></div><div class="col
col-6"><dl><dt>ASF</dt><dd><a href="http:/ [...]
+ <script
src="https://f.alicdn.com/react/15.4.1/react-with-addons.min.js";></script>
+ <script
src="https://f.alicdn.com/react/15.4.1/react-dom.min.js";></script>
+ <script>
+ window.rootPath = '';
+ </script>
+ <script src="/build/documentation.js"></script>
+</body>
+</html>
\ No newline at end of file
diff --git a/en-us/docs/development/commit-message.json
b/en-us/docs/development/commit-message.json
new file mode 100644
index 0000000..c2d6780
--- /dev/null
+++ b/en-us/docs/development/commit-message.json
@@ -0,0 +1,10 @@
+{
+ "filename": "commit-message.md",
+ "__html":
"<h2>DolphinScheduler-Contributor-CommitMessage</h2>\n<h3>Preface</h3>\n<p>A
good commit message can help other developers (or future developers) quickly
understand the context of related changes, and can also help project managers
determine whether the commit is suitable for inclusion in the release. But when
we checked the commit logs of many open source projects, we found an
interesting problem. Some developers have very good code quality, but the
commit message record is [...]
+ "link": "/en-us/docs/development/commit-message.html",
+ "meta": {
+ "title": "Commit Message",
+ "keywords": "DolphinScheduler, commit message, contibuting",
+ "description": "This documentation outlines the commit message format for
contributing to dolphine scheduler"
+ }
+}
\ No newline at end of file
diff --git a/zh-cn/docs/development/commit_message.html
b/zh-cn/docs/development/commit-message.html
similarity index 98%
rename from zh-cn/docs/development/commit_message.html
rename to zh-cn/docs/development/commit-message.html
index 8a4b7e1..d0ccbe8 100644
--- a/zh-cn/docs/development/commit_message.html
+++ b/zh-cn/docs/development/commit-message.html
@@ -4,10 +4,10 @@
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0,
maximum-scale=1.0, user-scalable=no">
- <meta name="keywords" content="commit_message" />
- <meta name="description" content="commit_message" />
+ <meta name="keywords" content="commit-message" />
+ <meta name="description" content="commit-message" />
<!-- 网页标签标题 -->
- <title>commit_message</title>
+ <title>commit-message</title>
<link rel="shortcut icon" href="/img/docsite.ico"/>
<link rel="stylesheet" href="/build/documentation.css" />
</head>
diff --git a/zh-cn/docs/development/commit_message.json
b/zh-cn/docs/development/commit-message.json
similarity index 98%
rename from zh-cn/docs/development/commit_message.json
rename to zh-cn/docs/development/commit-message.json
index 1e3f277..786ef6e 100644
--- a/zh-cn/docs/development/commit_message.json
+++ b/zh-cn/docs/development/commit-message.json
@@ -1,6 +1,6 @@
{
- "filename": "commit_message.md",
+ "filename": "commit-message.md",
"__html":
"<h2>DolphinScheduler-Contributor-CommitMessage篇</h2>\n<h3>前言</h3>\n<p>一个好的
commit message
是能够帮助其他的开发者（或者未来的开发者）快速理解相关变更的上下文，同时也可以帮助项目管理人员确定该提交是否适合包含在发行版中。但当我们在查看了很多开源项目的
commit log 后，发现一个有趣的问题，一部分开发者，代码质量很不错，但是 commit message
记录却比较混乱，当其他贡献者或者学习者在查看代码的时候，并不能通过 commit log 很直观的了解\n该提交前后变更的目的，正如 Peter
Hutterer 所言：Re-establishing the context of a piece of code is wasteful. We
can’t avoid it completely, so our efforts should go to reducing it as much as
possible. Commit messages c [...]
- "link": "/zh-cn/docs/development/commit_message.html",
+ "link": "/zh-cn/docs/development/commit-message.html",
"meta": {}
}
\ No newline at end of file
