CONTRIBUTING.md

THE FOLLOWING IS AN EXAMPLE FROM ATOM's CONTRIBUTING GUIDE

Visit GitHub.com/Atom/atom to read the complete description

Contributing to

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

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

Table Of Contents

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

I don't want to read this whole thing I just have a question!!!

What should I know before I get started?

and Packages

Package Conventions

How Can I Contribute?

Reporting Bugs

Before Submitting A Bug Report

Suggesting Enhancements

Before Submitting An Enhancement Suggestion

How Do I Submit A (Good) Enhancement Suggestion?

Your First Code Contribution

Local development

Pull Requests

Styleguides

Git Commit Messages

JavaScript Styleguide

CoffeeScript Styleguide

Specs Styleguide

Example

Documentation Styleguide

Example

Additional Notes

Issue and Pull Request Labels

Type of Issue and Issue State

Topic Categories

org/repo Topic Categories

Pull Request Labels