Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (39 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

47 lines (39 loc) · 2.63 KB

Contributing

How can I contribute?

How to contribute code?

Here are the basic steps to get started contributing code:

  1. Fork the repo and get development running on your computer.
  2. Install gulp and karma npm install gulp-cli karma-cli -g
  3. Install the npm development dependencies by the command npm install on the project folder (Should have NodeJS installed).
  4. Replicate the issue you're trying to fix or spec out the feature you're trying to add.
  5. Run gulp watch before start changing code. It will auto build and bundle the .js and .css files when you change.
  6. Change the code to fix the bug or add the feature. All changes should happen in the relevant src/js/*.js and src/css/*.css files.
  7. Build the code by running npm run build or gulp build.
  8. Run the test cases by running npm test or gulp test, you can also add more test cases based on your new change.
  9. Verify that your fix or feature works.
  10. Commit your changes with an informative description.
  11. Open a pull request to the dev branch of the repo with your new commit and a descriptive message about what the PR does.

Thank you for your contribution!

Notes for pull request
  • Follow the same code style as the library.
  • Run the test suites in the test directory first by running npm test or gulp test.
  • Don't modify any files in the dist directory.
  • Don't alter the licence headers.

Reporting bugs

Make sure it is a bug related to this project

Before reporting the bug, please make sure that the bug is in the project and not from your own code or any other library used.

Try the latest version

Bugs in the older versions of the project may have already been fixed. In order to avoid reporting known issues, make sure you are always testing against the latest release. Also make sure the problem hasn't already been reported on the GitHub Issues Tracker. If not, create a new issue there and include your test case.

Contributors

Million thanks to all our Code Contributors and Supporters.