Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

30 lines (20 loc) · 1.34 KB
Raw

Introduction

First off, thank you for considering contributing to this tool. It's people like you that make it all possible

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

Please, don't use the issue tracker for support questions.

Ground Rules

Responsibilities

  • Ensure cross-platform compatibility for every change that's accepted. Windows, Mac, Debian & Ubuntu Linux.
  • Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
  • Keep feature versions as small as possible, preferably one new feature per version.

Getting started

  1. Create your own fork of the code
  2. Do the changes in your fork

Your First Contribution

Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.

Bug Reports

When filing an issue, make sure to answer these important questions:

  1. What operating system are you using?
  2. What did you do?
  3. What did you expect to see?
  4. What did you see instead?