Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

24 lines (17 loc) · 1.62 KB
Raw

How to contribute

Thank you for being interested in contributing, we welcome people onto the project. Please read this document to get up to speed of the best ways to contribute to this project.

Ways you can help

There are many ways for you to help, even if you are not able to help with the Javascript elements of the project. Here are a few ways you can contribute:

  • Add new features to the extension with the Javascript
  • Improve the documentation here on GitHub
  • Test the extension and submit any bugs to the Issues section
  • Brainstorm new ideas and add them to the Issues section as Enhancements

Submitting changes

Please send a GitHub Pull Request with a clear list of what you've done (read more about pull requests). Each Pull Request should be on a feature branch with a prefix of feature-. Always write a clear log message for your commits. One-line messages are fine for small changes but please use the description to include any further details if requred.

Coding conventions

Start reading our code and you'll get the hang of it. We optimize for readability:

  • We indent using four spaces (soft tabs)
  • We ALWAYS put spaces after list items and method parameters ([1, 2, 3], not [1,2,3]), around operators (x += 1, not x+=1), and around hash arrows.
  • This is open source software. Consider the people who will read your code, and make it look nice for them.

Thanks