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/dolphinscheduler-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 227c7d4 Automated deployment: 7b76cc9862868980186c90753f8923e44f445c13
227c7d4 is described below
commit 227c7d4e5abdb5cc474d77469b2d11d695350844
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Fri Oct 8 16:30:04 2021 +0000
Automated deployment: 7b76cc9862868980186c90753f8923e44f445c13
---
en-us/community/development/pull-request.html | 37 +++++++++++++++-----------
en-us/community/development/pull-request.json | 2 +-
img/code-style-idea.png | Bin 503219 -> 397042 bytes
zh-cn/community/development/pull-request.html | 31 ++++++++++-----------
zh-cn/community/development/pull-request.json | 2 +-
5 files changed, 40 insertions(+), 32 deletions(-)
diff --git a/en-us/community/development/pull-request.html
b/en-us/community/development/pull-request.html
index edf7f2f..c68eda4 100644
--- a/en-us/community/development/pull-request.html
+++ b/en-us/community/development/pull-request.html
@@ -58,21 +58,28 @@
<h3>Pull Request content</h3>
<p>Please refer to the commit message section.</p>
<h3>Pull Request Code Style</h3>
-<p><a href="https://checkstyle.sourceforge.io/";>Checkstyle</a> is a
development tool to help programmers write Java code that adheres to a coding
standard. It automates the process of checking Java code to spare humans of
this boring (but important) task. This makes it ideal for projects that want to
enforce a coding standard.</p>
-<p>How to configure checkstyle and code style in dolphin scheduler:</p>
-<p>1.checkstyle and code-style configuration files</p>
-<p>checkstyle: <a
href="https://github.com/apache/dolphinscheduler/blob/dev/style/checkstyle.xml";>https://github.com/apache/dolphinscheduler/blob/dev/style/checkstyle.xml</a></p>
-<p>code-style: <a
href="https://github.com/apache/dolphinscheduler/blob/dev/style/intellij-java-code-style.xml";>https://github.com/apache/dolphinscheduler/blob/dev/style/intellij-java-code-style.xml</a></p>
-<p>2.checkstyle configuration</p>
- <p align="center">
- <img src="/img/checkstyle-idea.png" alt="checkstyle idea configuration" />
- </p>
-<p>3.code-style configuration</p>
- <p align="center">
- <img src="/img/code-style-idea.png" alt="code style idea configuration" />
- </p>
-<p>4.How to use checkstyle and code style</p>
-<p>After configuration, before submitting a Pull Request, the checkstyle tool
will automatically help you format code and import order in the changed code
file when you use <code>Ctrl+L</code>.</p>
+<p>Code style is the thing you have to consider when you submit pull request
for DolphinScheduler. We using <a
href="https://checkstyle.sourceforge.io";>Checkstyle</a>, a development tool to
help programmers write Java code that adheres to a coding standard, in CI to
keep DolphinScheduler codebase in the same style. Your pull request could not
be merged if your code style checker failed. You could format your code by
<em>Checkstyle</em> in your local environment before you submit your pul [...]
+<ol>
+<li>
+<p>Prepare Checkstyle configuration file: You could download it manually by <a
href="https://github.com/apache/dolphinscheduler/blob/dev/style/checkstyle.xml";>click
here</a>, but find it in DolphinScheduler repository would be a better way.
You could find configuration file in the path <code>style/checkstyle.xml</code>
after you clone repository from Github.</p>
+</li>
+<li>
+<p>Download Checkstyle plugins in Intellij IDEA: Search plugin by keyword
<strong>CheckStyle-IDEA</strong> or install in <a
href="https://plugins.jetbrains.com/plugin/1065-checkstyle-idea";>this page</a>.
You could see <a
href="https://www.jetbrains.com/help/idea/managing-plugins.html#install_plugin_from_repo";>install
plugin</a> if you do not know how to install plugin in Intellij IDEA</p>
+</li>
+<li>
+<p>Configure and activate Checkstyle and Intellij IDEA code-style: After
completing the above steps, you could configure and activate it in your
environment. You could find Checkstyle plugins in the path <code>Preferences
-> Tool -> Checkstyle</code>. After that you could activate Checkstyles
as screenshot show</p>
+</li>
+</ol>
+<p align="center">
+ <img src="/img/checkstyle-idea.png" alt="checkstyle idea configuration" />
+</p>
+<p>For now your Checkstyle plugins are setup, it would show codes and files
which out of style. We highly recommend you configure Intellij IDEA code-style
for auto-formatting your code in Intellij IDEA, you could find this setting in
<code>Preferences -> Editor -> Code Style -> Java</code> and then
activate it as screenshot show</p>
+<p align="center">
+ <img src="/img/code-style-idea.png" alt="code style idea configuration" />
+</p>
+<ol>
+<li>Format your codebase in Intellij IDEA before submit your pull request:
After you done above steps, you could using Intellij IDEA shortcut
<code>Command + L</code>(for Mac) or <code>Ctrl+L</code>(for Windows) to format
your code. The best time to format your code is before you commit your change
to your local git repository.</li>
+</ol>
<h3>Question</h3>
<ul>
<li>
diff --git a/en-us/community/development/pull-request.json
b/en-us/community/development/pull-request.json
index 6b95508..99b3b66 100644
--- a/en-us/community/development/pull-request.json
+++ b/en-us/community/development/pull-request.json
@@ -1,6 +1,6 @@
{
"filename": "pull-request.md",
- "__html": "<h1>Pull Request Notice</h1>\n<h2>Preface</h2>\n<p>Pull Request
is a way of software cooperation, which is a process of bringing code involving
different functions into the trunk. During this process, the code can be
discussed, reviewed, and modified.</p>\n<p>In Pull Request, we try not to
discuss the implementation of the code. The general implementation of the code
and its logic should be determined in Issue. In the Pull Request, we only focus
on the code format and code s [...]
+ "__html": "<h1>Pull Request Notice</h1>\n<h2>Preface</h2>\n<p>Pull Request
is a way of software cooperation, which is a process of bringing code involving
different functions into the trunk. During this process, the code can be
discussed, reviewed, and modified.</p>\n<p>In Pull Request, we try not to
discuss the implementation of the code. The general implementation of the code
and its logic should be determined in Issue. In the Pull Request, we only focus
on the code format and code s [...]
"link": "/dist/en-us/community/development/pull-request.html",
"meta": {}
}
\ No newline at end of file
diff --git a/img/code-style-idea.png b/img/code-style-idea.png
index 4e4177b..6c2ecfa 100644
Binary files a/img/code-style-idea.png and b/img/code-style-idea.png differ
diff --git a/zh-cn/community/development/pull-request.html
b/zh-cn/community/development/pull-request.html
index 702583c..f528f38 100644
--- a/zh-cn/community/development/pull-request.html
+++ b/zh-cn/community/development/pull-request.html
@@ -62,21 +62,22 @@ waste time。</p>
<h3>Pull Request 内容</h3>
<p>请参阅到 commit message 篇。</p>
<h3>Pull Request Code Style</h3>
-<p>checkstyle <a
href="https://checkstyle.sourceforge.io/";>参考</a>是一种帮助开发者编写遵循编码规范的 Java
代码开发工具。它可以自动化检查 Java 代码的方法以及格式，使得开发者不用再做这项无聊（但很重要）的任务。它非常适合于希望实施编码标准的项目。</p>
-<p>在 DolphinScheduler 中配置 checkstyle 和 code-style 的方式：</p>
-<p>1.checkstyle 和 code-style 配置文件</p>
-<p>checkstyle: <a
href="https://github.com/apache/dolphinscheduler/blob/dev/style/checkstyle.xml";>https://github.com/apache/dolphinscheduler/blob/dev/style/checkstyle.xml</a></p>
-<p>code-style: <a
href="https://github.com/apache/dolphinscheduler/blob/dev/style/intellij-java-code-style.xml";>https://github.com/apache/dolphinscheduler/blob/dev/style/intellij-java-code-style.xml</a></p>
-<p>2.checkstyle 配置过程</p>
- <p align="center">
- <img src="/img/checkstyle-idea.png" alt="checkstyle idea 配置方式" />
- </p>
-<p>3.code-style 配置过程</p>
- <p align="center">
- <img src="/img/code-style-idea.png" alt="code style idea 配置方式" />
- </p>
-<p>4.怎样使用 checkstyle 和 code-style</p>
-<p>当你配置完成后，在提交 Pull Request 前，在改动过后的代码文件中 <code>Ctrl+L</code>，checkstyle
工具就会自动帮你 format code 和 import 顺序。</p>
+<p>当你向 DolphinScheduler 提交 pull request 的时候 code-style 是你不得不考虑的问题。我们在 CI 中使用
Checkstyle <a
href="https://checkstyle.sourceforge.io/";>参考</a>来保持代码风格的统一，它是一种帮助开发者编写遵循编码规范的
Java 代码开发工具。如果你的 pull request 没有通过 Checkstyle 的检测，那它将不会被合并到主库中。你可以在提交 pull
request 前使用 Checkstyle 来检测或者格式化你的代码。如下的步骤将引领你配置并激活 Checkstyle</p>
+<ol>
+<li>准备 Checkstyle 配置文件：你可以点击<a
href="ttps://github.com/apache/dolphinscheduler/blob/dev/style/checkstyle.xml">这里</a>手动下载，但是我们更加推荐在
DolphinScheduler 代码库中找到它。当你将代码库克隆下来后，你可以在路径 <code>style/checkstyle.xml</code>
下找到配置文件</li>
+<li>下载 Intellij IDEA Checkstyle 插件：通过关键字<strong>CheckStyle-IDEA</strong>或者通过<a
href="https://plugins.jetbrains.com/plugin/1065-checkstyle-idea";>这个页面</a>安装均可。如果你不清楚如何安装Intellij
IDEA插件，可以参考<a
href="https://www.jetbrains.com/help/idea/managing-plugins.html#install_plugin_from_repo";>这个连接</a></li>
+<li>配置并激活 Checkstyles 以及 Intellij IDEA
代码风格：当完成上面几步后，你就可以配置并激活他们了。你可以在路径<code>Preferences -> Tool ->
Checkstyle</code>中找到 Checkstyle，请参照下图完成其配置</li>
+</ol>
+<p align="center">
+ <img src="/img/checkstyle-idea.png" alt="checkstyle idea configuration" />
+</p>
+<p>截止目前，Checkstyle 插件已经配置完成了，当有代码或者文件不符合风格时就会显示在 Checkstyle 中。但强烈建议同时配置
Intellij IDEA 的代码风格，完成配置后可以使用 Intellij IDEA 自动格式化功能。你可以在路径<code>Preferences
-> Editor -> Code Style -> Java</code>找到配置，请参照下图完成其配置</p>
+<p align="center">
+ <img src="/img/code-style-idea.png" alt="code style idea configuration" />
+</p>
+<ol>
+<li>在提交 pull request 前格式化你的代码：完成上面全部后，你可以使用快捷键<code>Command + L</code>(Mac用户)
or <code>Ctrl+L</code>(Windows用户)在 Intellij IDEA 完成自动格式化。格式化代码的最佳时间是将你的修改提交到本地
git 版本库之前</li>
+</ol>
<h3>相关问题</h3>
<ul>
<li>
diff --git a/zh-cn/community/development/pull-request.json
b/zh-cn/community/development/pull-request.json
index 8e55a0a..d88e9bd 100644
--- a/zh-cn/community/development/pull-request.json
+++ b/zh-cn/community/development/pull-request.json
@@ -1,6 +1,6 @@
{
"filename": "pull-request.md",
- "__html": "<h1>Pull Request 须知</h1>\n<h2>前言</h2>\n<p>Pull Request
本质上是一种软件的合作方式，是将涉及不同功能的代码，纳入主干的一种流程。这个过程中，可以进行讨论、审核和修改代码。</p>\n<p>在 Pull
Request 中尽量不讨论代码的实现方案，代码及其逻辑的大体实现方案应该尽量在\nIssue 或者邮件列表中被讨论确定，在 Pull Request
中我们尽量只关注代码的格式以及代码规范等信息，从而避免实现方式的意见不同而导致\nwaste time。</p>\n<h2>规范</h2>\n<h3>Pull
Request 标题</h3>\n<p>标题格式：[<code>Pull Request 类型</code>-<code>Issue
号</code>][<code>模块名</code>] <code>Pull Request 描述</code></p>\n<p>其中<code>Pull
Request 类型</code>和<code>Issue 类型</code>的对应关系如下：</p [...]
+ "__html": "<h1>Pull Request 须知</h1>\n<h2>前言</h2>\n<p>Pull Request
本质上是一种软件的合作方式，是将涉及不同功能的代码，纳入主干的一种流程。这个过程中，可以进行讨论、审核和修改代码。</p>\n<p>在 Pull
Request 中尽量不讨论代码的实现方案，代码及其逻辑的大体实现方案应该尽量在\nIssue 或者邮件列表中被讨论确定，在 Pull Request
中我们尽量只关注代码的格式以及代码规范等信息，从而避免实现方式的意见不同而导致\nwaste time。</p>\n<h2>规范</h2>\n<h3>Pull
Request 标题</h3>\n<p>标题格式：[<code>Pull Request 类型</code>-<code>Issue
号</code>][<code>模块名</code>] <code>Pull Request 描述</code></p>\n<p>其中<code>Pull
Request 类型</code>和<code>Issue 类型</code>的对应关系如下：</p [...]
"link": "/dist/zh-cn/community/development/pull-request.html",
"meta": {}
}
\ No newline at end of file
