The following is a set of guidelines for contributing to this project. These are not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report any unacceptable behavior to

How Can I Contribute?

For those looking to contribute to the development of the project, I recommend using the gulp watch command, to provide preprocessor compilation and live-reload functionalities.
Also, if you're looking for an easy way to contribute to this project but aren't sure where to start, I've created a list of minor bugs and/or issues to be fixed before the projects initial release, which you can find here or feel free to explore any other issue with a help wanted tag.

Reporting Bugs

This section guides you through submitting a bug report for Atom. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Enhancements & Feature Requests

Users provide the best insight for improving a product. So always feel free to suggest improvements, feedback, and give the developers an idea of what new features you'd like to see in the future.
Don't forget, this is one of the greatest benefits of open-source development!
If you'd like to submit an enhancement request, please include the following information: * Current project version (check that you are using the latest version) * How would this enhancement benefit most users? * Do you have any examples of other applications that feature this enhancement? * Relevant details about your configuration and environment. * Note: Don't forget to tag your post with the Enhancement label.

Pull Requests

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


Commit Messages


(Adapted from the contribution guidelines of Atom)