Skip to content

Latest commit

 

History

History
50 lines (30 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

50 lines (30 loc) · 1.8 KB
Raw

Contributing to Stencil

Thanks for showing interest in contributing!

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

By contributing to Stencil, you agree that your contributions will be licensed under its MIT license.

Table of Contents

Stencil Documentation

How Can I Contribute?

Styleguides

Your First Code Contribution

Unsure where to begin contributing to Stencil? Check our forums or our stackoverflow tag.

Pull Requests

  • Fill in the required template
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • End files with a newline.
  • Update CHANGELOG.md with a reference to your pull request if changing code

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference pull requests and external links liberally

JavaScript Styleguide

All JavaScript must adhere to AirBnB Javascript Styleguide.

CSS Styleguide

All CSS/Sass must adhere to Sass Coding Guidelines