Skip to content
This repository has been archived by the owner on Apr 30, 2019. It is now read-only.

Latest commit

 

History

History
54 lines (33 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

54 lines (33 loc) · 1.11 KB

Contributing

First of all, thanks for taking the time to submit a pull request!

These are the few notes and guidelines to keep things coherent.

Overview

  1. Check you have all requirements in place.
  2. Create your feature branch.
  3. Install the project dependencies for development.
  4. Test.
  5. Push your branch and submit a Pull Request.
  6. Add a description of your proposed changes and why they are needed.

We will review the changes as soon as possible.

Requirements

Install

This project uses cargo to manage dependencies so making a build will fetch anything required.

cargo build

If you are on Mac OSX you should probably use a custom OPENSSL_INCLUDE_DIR. For example, mine is installed in /usr/local/opt/openssl/include.

OPENSSL_INCLUDE_DIR=/usr/local/openssl/include cargo build

Feature Branch

git checkout -b features/feature-name

Test

cargo test