Ways To Contribute

These guidelines (not rules, per se; use your best judgment) were loosely adapted from those for Atom. And these guidelines, like the source code itself, is open to suggestions and pull requests.

We want to make contributing easy and fulfilling, and will endeavor to answer any questions you may have quickly. However, it may take a day to respond to queries; please be patient.

This document is intended to give you an overview of the infrastructure of the project. There is a separate document about the coding process itself.

We gladly accept contributions in any (constructive) form, including bug reports, bug fixes, enhancements, and testing and documentation updates.

Reporting Bugs

If you think you’ve found a bug, but aren’t sure, drop on by the Discussions Board and look for a similar issue, or start a new discussion and let us know what you’re seeing. We’ll do our best to help.

If you KNOW it’s a bug, please open a Bug Report and fill it out to the best of your ability.

If you feel able, fork the repository and see if you can correct the bug! Then create a Pull Request.

Suggesting Enhancements

Something missing? Or feel something could work better?

Feel free to add a Feature Request.

Or better still, fork the repository, add or update the feature, and create a Pull Request.

Creating a Pull Request

We’re thrilled to accept Pull Requests.

Before you submit a Pull Request, please be sure to:

  • Read the Code Of Conduct

  • Add or update test(s) which verify your new code works as it should (if applicable)

  • Add or update the documentation (if applicable)