You will need to complete a Contributor License Agreement (CLA). Briefly, this agreement testifies that you are granting us permission to use the submitted change according to the terms of the project's license, and that the work being submitted is under appropriate copyright.
- Always update to the most recent release; the bug may already be resolved.
- Search for similar issues in the issues list for this repo; it may already be an identified problem.
Fork Us, Then Create A Topic Branch For Your Work
The work you are doing for your pull request should not be done in the master branch of your forked repository. Create a topic branch for your work. This allows you to isolate the work you are doing from other changes that may be happening.
Your pull request should:
- Include a description of what your change intends to do
- Be a child commit of a reasonably recent commit in the master branch
- Requests need not be a single commit, but should be a linear sequence of commits (i.e. no merge commits in your PR)
- It is desirable, but not necessary, for the tests to pass at each commit
- Have clear commit messages
- e.g. "refactored feature", "fixed issue", "added tests for issue"
- Include adequate tests
- At least one test should fail in the absence of your non-test code changes. If your PR does not match this criteria, please specify why
- Tests should include reasonable permutations of the target fix/change
- Include baseline changes with your change
- All changed code must have 100% code coverage
- Follow the code conventions descriped in code style.
- To avoid line ending issues, set
autocrlf = inputandwhitespace = cr-at-eolin your git configuration
All code contributed to this project should adhere to a consistent style, so please keep these in mind before you submit your Pull Requests:
- Space indentation, size of 2.
- Semicolons are nice. Use them.
- Single quotes.
- No trailing whitespace.
- Be JSHint Valid.