Changeset View
Changeset View
Standalone View
Standalone View
CONTRIBUTING.md
Show First 20 Lines • Show All 72 Lines • ▼ Show 20 Lines | |||||
- [The Pragmatic Programmer: From Journeyman to Master](https://www.amazon.com/Pragmatic-Programmer-Journeyman-Master/dp/020161622X) | - [The Pragmatic Programmer: From Journeyman to Master](https://www.amazon.com/Pragmatic-Programmer-Journeyman-Master/dp/020161622X) | ||||
- [Advantages of monolithic version control](https://danluu.com/monorepo/) | - [Advantages of monolithic version control](https://danluu.com/monorepo/) | ||||
- [The importance of fixing bugs immediately](https://youtu.be/E2MIpi8pIvY?t=16m0s) | - [The importance of fixing bugs immediately](https://youtu.be/E2MIpi8pIvY?t=16m0s) | ||||
Getting set up with the Bitcoin ABC Repository | Getting set up with the Bitcoin ABC Repository | ||||
---------------------------------------------- | ---------------------------------------------- | ||||
1. Create an account at `https://reviews.bitcoinabc.org/` | 1. Create an account at https://reviews.bitcoinabc.org/ | ||||
2. Install Git and Arcanist on your machine | 2. Install Git and Arcanist on your machine | ||||
Git documentation can be found at: `https://git-scm.com/` | Git documentation can be found at: https://git-scm.com/ | ||||
Arcanist documentation can be found at: | Arcanist documentation can be found at: | ||||
`https://secure.phabricator.com/book/phabricator/article/arcanist_quick_start/` | https://secure.phabricator.com/book/phabricator/article/arcanist_quick_start/ | ||||
And: `https://secure.phabricator.com/book/phabricator/article/arcanist/` | And: https://secure.phabricator.com/book/phabricator/article/arcanist/ | ||||
To install these packages on Debian or Ubuntu, type: `sudo apt-get install git arcanist` | To install these packages on Debian or Ubuntu, type: `sudo apt-get install git arcanist` | ||||
3. If you do not already have an SSH key set up, follow these steps: | 3. If you do not already have an SSH key set up, follow these steps: | ||||
Type: `ssh-keygen -t rsa -b 4096 -C "your_email@example.com"` | Type: `ssh-keygen -t rsa -b 4096 -C "your_email@example.com"` | ||||
Enter a file in which to save the key (/home/*username*/.ssh/id_rsa): [Press enter] | Enter a file in which to save the key (/home/*username*/.ssh/id_rsa): [Press enter] | ||||
▲ Show 20 Lines • Show All 80 Lines • ▼ Show 20 Lines | |||||
- When reviewing a Diff, apply the changeset on your local by using | - When reviewing a Diff, apply the changeset on your local by using | ||||
`arc patch D{NNNN}` | `arc patch D{NNNN}` | ||||
What to work on | What to work on | ||||
--------------- | --------------- | ||||
If you are looking for a useful task to contribute to the project, a good place | If you are looking for a useful task to contribute to the project, a good place | ||||
to start is the list of tasks at `https://reviews.bitcoinabc.org/maniphest/`. | to start is the list of tasks at https://reviews.bitcoinabc.org/maniphest/ | ||||
You can also get in touch with some of the developers in the open BTCForks Slack | You can also get in touch with some of the developers in the open BTCForks Slack | ||||
channel at `https://btcforks.slack.com/` | channel at https://btcforks.slack.com/ | ||||
Copyright | Copyright | ||||
--------- | --------- | ||||
By contributing to this repository, you agree to license your work under the | By contributing to this repository, you agree to license your work under the | ||||
MIT license unless specified otherwise in `contrib/debian/copyright` or at | MIT license unless specified otherwise in `contrib/debian/copyright` or at | ||||
the top of the file itself. Any work contributed where you are not the original | the top of the file itself. Any work contributed where you are not the original | ||||
author must contain its license header with the original author(s) and source. | author must contain its license header with the original author(s) and source. | ||||
Disclosure Policy | Disclosure Policy | ||||
----------------- | ----------------- | ||||
See [DISCLOSURE_POLICY](DISCLOSURE_POLICY). | See [DISCLOSURE_POLICY](DISCLOSURE_POLICY). |