Changeset View
Changeset View
Standalone View
Standalone View
CONTRIBUTING.md
Show First 20 Lines • Show All 116 Lines • ▼ Show 20 Lines | |||||
``` | ``` | ||||
Note: Arcanist tooling will tend to fail if your remote origin is set to something other | Note: Arcanist tooling will tend to fail if your remote origin is set to something other | ||||
than the above. A common mistake is to clone from Github and then forget to update | than the above. A common mistake is to clone from Github and then forget to update | ||||
your remotes. | your remotes. | ||||
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 | Contributing to the node software | ||||
--------------------------------- | |||||
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): | On Ubuntu (>= 18.04+updates): | ||||
``` | ``` | ||||
Show All 28 Lines | |||||
Arcanist will tell you what version is expected and what is found when running `arc lint` against a shell script. | Arcanist will tell you what version is expected and what is found when running `arc lint` against a shell script. | ||||
If you are running Debian 10, it is also available in the backports repository: | If you are running Debian 10, it is also available in the backports repository: | ||||
``` | ``` | ||||
sudo apt-get -t buster-backports install shellcheck | sudo apt-get -t buster-backports install shellcheck | ||||
``` | ``` | ||||
Contributing to the web projects | |||||
-------------------------------- | |||||
If you intend to contribute to web projects, you will need `nodejs`. | |||||
Follow the [installation instructions](https://github.com/nvm-sh/nvm#installing-and-updating) | |||||
to install node with node version manager. Then: | |||||
``` | |||||
cd bitcoin-abc | |||||
sudo npm install -g prettier | |||||
``` | |||||
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 | ||||
▲ Show 20 Lines • Show All 65 Lines • Show Last 20 Lines |