Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

44 lines (27 loc) · 1.45 KB
Raw

Contributing to Project Name

First off, thanks for taking the time to contribute!

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

How Can I Contribute?

Reporting Bugs

If you find a bug, please provide as much information as possible about the bug and how it occurred.

Suggesting Enhancements

If you have an idea for a new feature or an enhancement to an existing one, we'd love to hear about it!

Pull Requests

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Styleguides

Git Commit Messages

  • Must be structured as <type>(<scope>): <description> where type is one of build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test, and scope is optional.
  • 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
  • Longer descriptions and other optional information should be added after a blank line.

JavaScript Styleguide

All JavaScript must adhere to JavaScript Standard Style.

CSS Styleguide

All CSS must adhere to CSS Standard Style.