Skip to content

Latest commit

 

History

History
120 lines (81 loc) · 4.48 KB

CONTRIBUTING.md

File metadata and controls

120 lines (81 loc) · 4.48 KB
Raw

Contributing to This Project

This is a free and open-source software project and we love receiving pull-requests, bug reports, ideas, and feedback from everyone. The aim of this document is to help you get setup for participating in all areas of this project quickly—whether that's submitting code via a pull request, testing the latest iteration, reporting issues, writing documentation, etc.

Understanding the Components Involved

Jam is a web UI for JoinMarket with focus on user-friendliness. The web UI's purpose is to be a rather lightweight front end for the JoinMarket API. To function, the web UI needs to connect to an instance of JoinMarket with the API service running.

You don't need to worry about that, though. To ease development and testing, we provide a Docker setup that runs JoinMarket and its API service in a regtest setup.

Submitting a Pull Request

Fork, then clone this repo:

git clone git@github.com:<your-username>/jam.git

Install dependencies:

npm install

Start the JoinMarket HTTP API service in regtest. It isn't needed to dig deeper into how it works to use it. However, if you want to find out more about it, see docker/regtest/readme.md.

npm run regtest:up

Initialize the regtest setup:

npm run regtest:init

This creates and funds a wallet Satoshi with password test.

Start the UI on port 3000:

npm run dev:start

Make your changes and be sure to manually test them before submitting them to us.

Once you're sure the changes work well, push to your fork and submit a pull request. We will try to at least comment on your pull request within a couple of days. We may suggest some changes, improvements, or alternatives.

Some things that will increase the chance that your pull request is accepted:

  • Make sure the changes work well and cover edge cases.
  • Make sure your code is formatted. This should happen automatically using a Git commit-hook. If not, see docs/developing.md for more details.
  • Write a meaningful pull request description message.

If your pull request is accepted, a maintainer will squash it into master. We follow the conventional commits convention when squashing pull requests to master. You can follow this convention for commits on your fork but this isn't a requirement for your pull request to be accepted.

Testing the Latest Iteration

Clone this repo:

git clone git@github.com:joinmarket-webui/jam.git

Checkout the version you want to test. If you want to test the cutting edge development version, simply skip this step and test directly on master.

git fetch --tags git checkout <version>

Install dependencies:

npm install

Start the JoinMarket HTTP API service in regtest. It isn't needed to dig deeper into how it works to use it. However, if you want to find out more about it, see docker/regtest/readme.md.

npm run regtest:up

Initialize the regtest setup:

npm run regtest:init

This creates and funds a wallet Satoshi with password test.

Start the UI on port 3000:

npm run dev:start

Enjoy the test drive!

Dev Setup

When running Jam in dev mode, additional Jam instances are provided by default. These instances can be used to set up different wallets and simulate collaborative transactions. A block explorer and RPC terminal are also available for directly interacting with the regtest node.

Information on how to access these development features can be found at http://localhost:3000/dev-setup.

Reporting Issues

Reporting an issue is as easy as opening one on GitHub. Be sure to provide a detailed description of what you think is wrong and add as much context as possible. If applicable, include step-by-step instruction on how to reproduce the issue. Before you submit an issue, please have a quick look at the currently open issues. You might find that another person has already reported the same thing.