Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

37 lines (23 loc) · 2.03 KB

Introduction

First off, thank you for considering contributing to ~. It's people like you that make ~ such a great tool.

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

You can help

~ is an open source project and we love to receive contributions from our community — you!

There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into ~ itself. You are also free to talk about this tool anywhere you want to: your lgs, your EDH friendly pod, your discord server, your twitch or youtube channel. Do as you want to.

Feel free to use the issue tracker for support questions or to let us a quick thank you note :)

Ground Rules

  • Ensure cross-platform compatibility for every change that's accepted. Firefox, Chrome, etc.
  • Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
  • Don't add any dependances to the codebase unless absolutely needed.
  • Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. See the Code of Conduct.

Your First Contribution

Unsure where to begin contributing to ~? You can start by looking through these good first issues.

Working on your first Pull Request? You can learn how here: http://makeapullrequest.com/ and http://www.firsttimersonly.com/. At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first 😸

Getting started

For something that is bigger than a one or two line fix:

  1. Create your own fork of the code
  2. Do the changes in your fork
  3. Send a pull request.