Skip to content

Latest commit

 

History

History
57 lines (33 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

57 lines (33 loc) · 1.92 KB

Contributing to this project

Firstly, thank you getting involved!

What should I know before I get started?

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code.

Please report unacceptable behaviour to [email protected].

How Can I Contribute?

Pull Requests

We ❤️ pull requests.

Reporting Bugs

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behaviour 💻 💻, and find related reports 🔎.

Before creating bug reports, please perform a search as you might find out that you don't need to create one.

Before you commit

Please make sure you do the following before committing code:

  • do a quick smoke-test to ensure the app appears to be functioning as expected
  • run npm run build – ensure no errors

Style Guide

We're mostly following Airbnb's JavaScript style guide, with a few overrides that you can check in our .eslintrc file. The lint task will catch most of these so be sure to run it (npm run lint) on your code.

Code Conventions

  • We ❤️ semicolons ;
  • Commas last ,
  • 2 spaces for indentation (no tabs)
  • Prefer single ' over double " quotes.
  • Except in JSX. Use double quotes in JSX: <MyComponent classNames="thank you" />
  • 100 character line length
  • Do not use underscore prefix for "private" methods.
  • In fact, you probably don't need private methods. Try to keep components small. Compose.

Git commits

  • 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 issues and pull requests liberally ("Fix #17")