Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 950 Bytes

CONTRIBUTING.md

File metadata and controls

50 lines (32 loc) · 950 Bytes

Contributing

We welcome contributions to this project. Here is a step by step guide to help you get started.

Installation

Before you start make sure you have node and npm installed on your machine. Also make sure you have docker installed and running.

Remove any existing installations of the package:

npm remove -g bitbrew
  1. Clone the repository and navigate to the project directory
git clone git@github.com:rishkwal/bitbrew.git
cd bitbrew
  1. Install dependencies
npm install --legacy-peer-deps
  1. Build the package
npm run build
  1. Give executable permissions to the binary
chmod +x ./dist/src/bin/bitbrew.js
  1. Link the package
npm link

Now you can run the bitbrew command from anywhere in your terminal.

Reporting Bugs

If you find a bug in the project, please open an issue on the issues page.