Skip to content

Latest commit

 

History

History
51 lines (35 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

51 lines (35 loc) · 1.57 KB

Contributing to BLiP Toolkit

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

The following is a set of guidelines for contributing to BLiP Toolkit and its components, which are hosted in the Take on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Tests

We are trying to cover all of our components with tests to make more consistent and reliable code. So, whenever possible, write some tests while creating new components.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Reference issues and pull requests liberally at the end of line

JavaScript Styleguide

All JavaScript must adhere to JavaScript Standard Style.

  • Use the object spread operator ({...anotherObj}) instead of Object.assign()
  • Inline named exports with expressions whenever possible
  // Use this:
  export class ClassName {

  }

  // Instead of:
  export default class ClassName {

  }

Specs Styleguide

  • Include thoughtfully-worded, well-structured Jasmine specs in the ./spec/tests folder.
  • Treat describe as a noun or situation.
  • Treat it as a statement about state or how an operation changes state.

Example

describe 'a dog', ->
 it 'barks', ->
 # spec here
 describe 'when the dog is happy', ->
  it 'wags its tail', ->
  # spec here