Changeset View
Changeset View
Standalone View
Standalone View
CONTRIBUTING.md
Show First 20 Lines • Show All 121 Lines • ▼ Show 20 Lines | |||||
Follow instructions provided by `arc install-certificate` to provide your API token. | Follow instructions provided by `arc install-certificate` to provide your API token. | ||||
6. Code formatting tools | 6. Code formatting tools | ||||
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 clang-format-8, clang-tidy (version >=8), autopep8, flake8, | will have to install the following: | ||||
phpcs and shellcheck. | |||||
To install clang-format-8 and clang-tidy 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 | sudo apt-get install clang-format-8 clang-tidy-8 clang-tools-8 python-autopep8 flake8 php-codesniffer shellcheck | ||||
``` | ``` | ||||
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 | ||||
ln -s $PWD/clang+llvm-8.0.0-x86_64-apple-darwin/bin/clang-format /usr/local/bin/clang-format | ln -s $PWD/clang+llvm-8.0.0-x86_64-apple-darwin/bin/clang-format /usr/local/bin/clang-format | ||||
ln -s $PWD/clang+llvm-8.0.0-x86_64-apple-darwin/bin/clang-tidy /usr/local/bin/clang-tidy | ln -s $PWD/clang+llvm-8.0.0-x86_64-apple-darwin/bin/clang-tidy /usr/local/bin/clang-tidy | ||||
``` | ``` | ||||
To install autopep8, flake8 and phpcs on Ubuntu: | |||||
``` | |||||
sudo apt-get install python-autopep8 flake8 php-codesniffer shellcheck | |||||
``` | |||||
Working with The Bitcoin ABC Repository | Working with The Bitcoin ABC Repository | ||||
--------------------------------------- | --------------------------------------- | ||||
A typical workflow would be: | A typical workflow would be: | ||||
- Create a topic branch in Git for your changes | - Create a topic branch in Git for your changes | ||||
git checkout -b 'my-topic-branch' | git checkout -b 'my-topic-branch' | ||||
▲ Show 20 Lines • Show All 64 Lines • Show Last 20 Lines |