Skip to content

Latest commit

 

History

History
32 lines (19 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

32 lines (19 loc) · 1.37 KB
Raw

#Contributing to Apickli

Thank you for considering contributing to apickli.

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

  • Before submitting, please read the guide below to know more about coding conventions and benchmarks.

Code Conventions

In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.

To test the code run gulp test

To test that the console outputs correctly run gulp console-test. Some of these tests should fail, that is expected behavior. The failed tests are designed to show how the console will output failed tests.

To lint your code run gulp jshint

Thank you for your contribution!