Introduction

Contributing guide

Raising Issues

The GitHub issue tracker is the preferred channel for bug reports, change requests and submitting pull requests, but please respect the following restrictions:

  • Please search for existing issues. Help us keep duplicate issues to a minimum by checking to see if someone has already reported your problem or requested your idea.
  • Please do not use the issue tracker for personal support requests, use Discord.
  • Please do not derail or troll issues. Keep the discussion on topic and respect the opinions of others.

## Bug Reports

A bug is a demonstrable problem that is caused by the code in the repository.
Good bug reports are extremely helpful - thank you!

Guidelines for bug reports:

  1. Use the GitHub issue search — check if the issue has already been reported.
  2. Check if the issue has been fixed — try to reproduce it using the latest master.
  3. Isolate the problem — ideally create a reduced test case and a live example.
  4. Include as much info as possible! Use the issue template below.
Short and descriptive example bug report title.

### Issue Summary

A summary of the issue and the OS environment in which it occurs.

### Steps to Reproduce

1. This is the first step
2. This is the second step, etc.

Any other info e.g. Why do you consider this to be a bug? What did you expect to happen instead?

### Technical details:

* Coinolio Version: master (latest commit: a761de2079dca4df49567b1bddac492f25033985)
* Node Version: 4.4.7
* Platform OS: Mac OS X 10.10.4

Feature Requests

We'd love to have you're ideas and suggestions on how to improve Coinolio.

If you have ideas, the best place to talk to us about them is on our Discord.

Developing Coinolio

Submitted Pull Requests

Pull requests are awesome. If you're looking to raise a PR for something which doesn't have an open issue, please think carefully about raising an issue which your PR can close, especially if you're fixing a bug. This makes it more likely that there will be enough information available for your PR to be properly tested and merged. To make sure your PR is accepted as quickly as possible, please take a minute to check the guidelines on:

Testing and Quality Assurance

## Checking tests pass
Run npm test to check that your work passes ESLint linting and available unit tests. If this fails, your PR will throw an error when submitted.

Documentation

These docs are written and hosted on readme.io which has a suggested edits feature through which you can submit updates. If you'd like to get more involved than just making amendments, please message us via Discord.

Contributor License Agreement

By contributing your code to Coinolio you grant the Coinolio a non-exclusive, irrevocable, worldwide, royalty-free, sublicenseable, transferable license under all of Your relevant intellectual property rights (including copyright, patent, and any other rights), to use, copy, prepare derivative works of, distribute and publicly perform and display the Contributions on any licensing terms, including without limitation:
(a) open source licenses like the MIT license; and (b) binary, proprietary, or commercial licenses. Except for the licenses granted herein, You reserve all right, title, and interest in and to the Contribution.

You confirm that you are able to grant us these rights. You represent that You are legally entitled to grant the above license. If Your employer has rights to intellectual property that You create, You represent that You have received permission to make the Contributions on behalf of that employer, or that Your employer has waived such rights for the Contributions.

You represent that the Contributions are Your original works of authorship, and to Your knowledge, no other person claims, or has the right to claim, any right in any invention or patent related to the Contributions. You also represent that You are not legally obligated, whether by entering into an agreement or otherwise, in any way that conflicts with the terms of this license.

Coinolio acknowledges that, except as explicitly described in this Agreement, any Contribution which you provide is on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.