Skip to content

Latest commit

 

History

History
103 lines (77 loc) · 4.14 KB

contributing.md

File metadata and controls

103 lines (77 loc) · 4.14 KB
Raw

Contributing

We would love for you to contribute and help us make this even better! Start reading this document to see it is not difficult as you might have imagined.

Table of Contents

Open an Issue

Open an Issue to report any problems or improvements. When necessary, use some online service like JS Bin, JSFiddle, Codepen, to show the problem. Be sure to include some description to explain the problem.

Submit a Pull Request

To submit a new feature, make sure that changes are done to the source code. Follow our style guide and do not forget the tests.

Try to solve a problem for each pull request, this increases the chances of acceptance. When in doubt, open a new issue so we can answer you. Look existing issues for ideas or to see if a similar issue has already been submitted.

  1. Fork the Github repo: git clone https://github.com/repo/name.git
  2. Create a new branch: git checkout -b issuenumber-feature-name
  3. Commit your changes: git commit -m 'issuenumber-feature-name'
  4. Push to the branch: git push origin my-feature-name
  5. Submit a pull request!

Style Guide

Look at how the code is being maintained, we must always be consistent. We try to follow best practices as much as possible. In addition, here are some tips you should follow:

For JavaScript:

  • No semicolons.
  • No unused variables.
  • Use tab for indentation.
  • Use === instead of ==.
  • Use single quotes for strings except to avoid escaping.
  • Add a space after keywords.
  • Add a space before a function declaration's parentheses.
  • Infix operators must be spaced.
  • Commas should have a space after them.
  • Keep else statements on the same line as their curly braces.
  • For multi-line if statements, use curly braces.
  • Always handle the err function parameter.
  • Always prefix browser globals with window..
  • Multiple blank lines not allowed.
  • For the ternary operator in a multi-line setting, place ? and : on their own lines.
  • For var declarations, write each declaration in its own statement.
  • Wrap conditional assignments with additional parentheses. This makes it clear that the expression is intentionally an assignment (=) rather than a typo for equality (===).

For Stylesheet:

  • Properties and selectors are sorted in alphabetical order
  • Always use tab to indentation, no spaces
  • Always use single quote, i.e. content: ''
  • Quote attribute values in selectors, i.e. input[type='checkbox']
  • Avoid specifying units for zero-values, i.e. margin: 0
  • Use rem unit instead of px
  • Use lowercase and shorthand hex values, i.e. #fff
  • Use one discrete selector per line in multi-selector rulesets
  • Include a single space after colon and after each comma
  • Separate each ruleset by a blank line
  • Don't use prefixes, there is a task to generate this automatically
.selector-a,
.selector-b,
.selector-c,
.selector-d[type='text']
  box-sizing: border-box
  color: #333
  content: ''
  display: inline-block
  font-family: 'Helvetica-Neue', 'Helvetica', 'Arial', sans-serif
  margin-bottom: 0
  margin-left: 5.0rem

  .other-selector-a
    background: #fff

    .other-selector-b
      background: #fff

    &.increasing-the-specificity
      color: #000

NOTE: The best way to learn about that is to just install it and give it a try on your code. This project uses an .editorconfig file, which most editors support, to enforce these coding standards.

Test

First install Node.js. Now install all the dependencies, run npm install from the project directory. Once you have the dependencies installed, run npm test.

Code of Conduct

Help us keep this project open and inclusive. Please read and follow our thoughts on Code of Conduct.

License

By contributing your code, you agree to license your contribution under the MIT license.