A BIG thank you from everyone using one of our projects and for taking the time to contribute! 👏
The following is a set of guidelines for contributing to our projects and its components, These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.
This guide will be constantly updated.
- You can create a new GitHub issue, but before doing that please read the notes below on submitting issues, and include as many details as possible with your report.
- Include screenshots, animated GIFs or screencasts whenever possible; they are immensely helpful.
- Include the behavior you expected and other places you've seen that behavior
- Perform a cursory search of any existing issues to see if a similar issue has already been submitted.
Please see our PR best practices guide for more information.
We use eslint provided by make-up to ensure consistency in our repos, this uses our JS linting rules.
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally
- Consider starting the commit message with an applicable emoji:
- 🐛
:bug:when fixing a bug - 🐎
:racehorse:when improving performance - 📝
:memo:when writing docs - 🔥
:fire:when removing code or files - 🔒
:lock:when dealing with security - ⬆️
:arrow_up:when upgrading dependencies - ⬇️
:arrow_down:when downgrading dependencies
- 🐛
--
Based on the wonderful Contribution.md file from the guys and girls at atom