Changeset View
Changeset View
Standalone View
Standalone View
CONTRIBUTING.md
Show First 20 Lines • Show All 125 Lines • ▼ Show 20 Lines | |||||
During submission of patches, arcanist will automatically run `arc lint` to | During submission of patches, arcanist will automatically run `arc lint` to | ||||
enforce Bitcoin ABC code formatting standards, and often suggests changes. | enforce Bitcoin ABC code formatting standards, and often suggests changes. | ||||
If code formatting tools do not install automatically on your system, you | If code formatting tools do not install automatically on your system, you | ||||
will have to install the following: | will have to install the following: | ||||
On Ubuntu (>= 18.04+updates) or Debian (>= 10): | On Ubuntu (>= 18.04+updates) or Debian (>= 10): | ||||
``` | ``` | ||||
sudo apt-get install clang-format-8 clang-tidy-8 clang-tools-8 python-autopep8 flake8 php-codesniffer shellcheck | sudo apt-get install clang-format-8 clang-tidy-8 clang-tools-8 cppcheck python-autopep8 flake8 php-codesniffer shellcheck | ||||
jasonbcox: Note that when you add new dev dependencies that affect linting, they need to be added to the… | |||||
``` | ``` | ||||
If not available in the distribution, `clang-format-8` and `clang-tidy` can be | If not available in the distribution, `clang-format-8` and `clang-tidy` can be | ||||
installed from https://releases.llvm.org/download.html or https://apt.llvm.org. | installed from https://releases.llvm.org/download.html or https://apt.llvm.org. | ||||
For example, for macOS: | For example, for macOS: | ||||
``` | ``` | ||||
curl http://releases.llvm.org/8.0.0/clang+llvm-8.0.0-x86_64-apple-darwin.tar.xz | tar -xJv | curl http://releases.llvm.org/8.0.0/clang+llvm-8.0.0-x86_64-apple-darwin.tar.xz | tar -xJv | ||||
▲ Show 20 Lines • Show All 76 Lines • Show Last 20 Lines |
Note that when you add new dev dependencies that affect linting, they need to be added to the base image setup script as well.