Skip to content

Latest commit

 

History

History
67 lines (41 loc) · 3.19 KB

CONTRIBUTING.md

File metadata and controls

67 lines (41 loc) · 3.19 KB
Raw

How to contribute

Please read this short guide to contributing before performing pull requests or reporting issues. The purpose of this guide is to ensure the best experience for all involved and make development as smooth as possible.

Reporting issues

To report a bug, request a feature, or even ask a question, make use of the GitHub Issues in this repo. When submitting an issue please take the following steps:

1. Search for existing issues. Your bug may have already been fixed or addressed in an unreleased version, so be sure to search the issues first before putting in a duplicate issue.

2. Create an isolated and reproducible test case. If you are reporting a bug, make sure you also have a minimal, runnable, code example that reproduces the problem you have.

3. Include a live example. After narrowing your code down to only the problem areas, make use of jsFiddle, jsBin, or a link to your live site so that we can view a live example of the problem.

4. Share as much information as possible. Include browser/node version affected, your OS, version of the library, steps to reproduce, etc. "X isn't working!!!1!" will probably just be closed.

Making Changes

To build the library you will need to download node.js from nodejs.org. After it has been installed open a console and run npm install -g gulp to install the global gulp executable.

After that you can clone the repository and run npm install inside the cloned folder. This will install dependencies necessary for building the project. You can rebuild the project by running gulp in the cloned folder.

Once that is ready, you can make your changes and submit a Pull Request:

  • Send Pull Requests to the master branch. All Pull Requests must be sent to the master branch, which is where all "bleeding-edge" development takes place.

  • Ensure changes are jshint validated. Our JSHint configuration file is provided in the repository and you should check against it before submitting. This should happen automatically when running gulp in the repo directory.

  • Never commit new builds. When making a code change you should always run gulp which will rebuild the project so you can test, however please do not commit the new builds placed in dist/ or your PR will be closed. By default the dist/ folder is ignored so this shouldn't happen by accident.

  • Only commit relevant changes. Don't include changes that are not directly relevant to the fix you are making. The more focused a PR is, the faster it will get attention and be merged. Extra files changing only whitespace or trash files will likely get your PR closed.

Quickie Code Style Guide

Use EditorConfig and JSHint! Both tools will ensure your code is in the required styles! Either way, here are some tips:

  • Use 4 spaces for tabs, never tab characters.

  • No trailing whitespace, blank lines should have no whitespace.

  • Always favor strict equals === unless you need to use type coercion.

  • Follow conventions already in the code, and listen to jshint. Our config is set-up for a reason.