You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@doris.apache.org by GitBox <gi...@apache.org> on 2021/12/05 09:35:08 UTC
[GitHub] [incubator-doris] jackwener opened a new pull request #7306: [document] add java formatter in doc
jackwener opened a new pull request #7306:
URL: https://github.com/apache/incubator-doris/pull/7306
## Proposed changes
Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.
## Types of changes
What types of changes does your code introduce to Doris?
_Put an `x` in the boxes that apply_
- [ ] Bugfix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [x] Documentation Update (if none of the other choices apply)
- [ ] Code refactor (Modify the code structure, format the code, etc...)
- [ ] Optimization. Including functional usability improvements and performance improvements.
- [ ] Dependency. Such as changes related to third-party components.
- [ ] Other.
## Checklist
_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._
- [ ] I have created an issue on (Fix #ISSUE) and described the bug/feature there in detail
- [ ] Compiling and unit tests pass locally with my changes
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] If these changes need document changes, I have updated the document
- [ ] Any dependent changes have been merged
## Further comments
None
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] github-actions[bot] commented on pull request #7306: [document] add java formatter in doc
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #7306:
URL: https://github.com/apache/incubator-doris/pull/7306#issuecomment-987981738
PR approved by at least one committer and no changes requested.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] github-actions[bot] commented on pull request #7306: [document] add java formatter in doc
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #7306:
URL: https://github.com/apache/incubator-doris/pull/7306#issuecomment-987646808
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] morningman commented on a change in pull request #7306: [document] add java formatter in doc
Posted by GitBox <gi...@apache.org>.
morningman commented on a change in pull request #7306:
URL: https://github.com/apache/incubator-doris/pull/7306#discussion_r764050609
##########
File path: docs/en/developer-guide/java-format-code.md
##########
@@ -45,3 +45,15 @@ javax
* Do not use `import *`
* Do not use `import static`
+
+## Checkstyle
+
+Now we have `formatter-check` in `CI` to check the code format.
+
+If you use `IDEA` to develop Java code, please install `Checkstyle-IDEA` plugin.
+
+Setting the `checkstyle.xml` file in `Tools->Checkstyle`.
+
+Click the plus sign under Configuration File, Select `Use a local Checkstyle file`, and select the `checkstyle.xml` file.
Review comment:
```suggestion
Click the plus sign under Configuration File, Select `Use a local Checkstyle file`, and select the `fe/checkstyle.xml` file.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] jackwener commented on pull request #7306: [document] add java formatter in doc
Posted by GitBox <gi...@apache.org>.
jackwener commented on pull request #7306:
URL: https://github.com/apache/incubator-doris/pull/7306#issuecomment-987980855
Thanks for your review
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] morningman merged pull request #7306: [document] add java formatter in doc
Posted by GitBox <gi...@apache.org>.
morningman merged pull request #7306:
URL: https://github.com/apache/incubator-doris/pull/7306
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] jackwener commented on pull request #7306: [document] add java formatter in doc
Posted by GitBox <gi...@apache.org>.
jackwener commented on pull request #7306:
URL: https://github.com/apache/incubator-doris/pull/7306#issuecomment-987979102
Fixed
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] morningman commented on a change in pull request #7306: [document] add java formatter in doc
Posted by GitBox <gi...@apache.org>.
morningman commented on a change in pull request #7306:
URL: https://github.com/apache/incubator-doris/pull/7306#discussion_r764039692
##########
File path: docs/zh-CN/developer-guide/java-format-code.md
##########
@@ -45,3 +45,14 @@ javax
* 禁止使用 `import *`
* 禁止使用 `import static`
+
+## Checkstyle
+
+现在的 `CI` 之中会有 `formatter-check` 进行代码格式化检测。
+
+如果使用 `IDEA` 进行 Java 开发，请在设置中安装 `Checkstyle-IDEA` 插件。
+
+在 `Tools->Checkstyle` 的 `Configuration File` 里点击 `Use a local Checkstyle file`，选择项目的 `checkstyle.xml` 文件。
Review comment:
```suggestion
在 `Tools->Checkstyle` 的 `Configuration File` 里点击 `Use a local Checkstyle file`，选择项目的 `fe/checkstyle.xml` 文件。
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org