[
https://issues.apache.org/jira/browse/ARROW-15248?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
David Li updated ARROW-15248:
-----------------------------
Description:
[Code Style, Linting, and
CI|https://arrow.apache.org/docs/developers/cpp/development.html#code-style-linting-and-ci]
could use the following:
* clang-format is implicitly described, but should be made an explicit
requirement.
* We should describe how to format C++ code with archery.
* We should describe how to format/lint C++ code with the CMake build.
* We should describe how Archery discovers the clang-format/cpplint
executables.
* We should describe how to use the GitHub Actions bot to try to format code.
* If the wrong version of clang-format or clang-tidy is found, we should
explicitly note that instead of just saying 'not found'
was:
[Code Style, Linting, and
CI|https://arrow.apache.org/docs/developers/cpp/development.html#code-style-linting-and-ci]
could use the following:
* clang-format is implicitly described, but should be made an explicit
requirement.
* We should describe how to format C++ code with archery.
* We should describe how to format/lint C++ code with the CMake build.
* We should describe how Archery discovers the clang-format/cpplint
executables.
* We should describe how to use the GitHub Actions bot to try to format code.
> [C++][Docs] Improve instructions for C++ formatting/linting
> -----------------------------------------------------------
>
> Key: ARROW-15248
> URL: https://issues.apache.org/jira/browse/ARROW-15248
> Project: Apache Arrow
> Issue Type: Improvement
> Components: C++, Documentation
> Reporter: David Li
> Priority: Major
>
> [Code Style, Linting, and
> CI|https://arrow.apache.org/docs/developers/cpp/development.html#code-style-linting-and-ci]
> could use the following:
> * clang-format is implicitly described, but should be made an explicit
> requirement.
> * We should describe how to format C++ code with archery.
> * We should describe how to format/lint C++ code with the CMake build.
> * We should describe how Archery discovers the clang-format/cpplint
> executables.
> * We should describe how to use the GitHub Actions bot to try to format code.
> * If the wrong version of clang-format or clang-tidy is found, we should
> explicitly note that instead of just saying 'not found'
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
