Skip to content

Latest commit

 

History

History
26 lines (21 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

26 lines (21 loc) · 1.76 KB
Raw

Reporting issues

Make sure the report is accompanied by a reproducible demo. The ideal demo is created by forking our standard jsFiddle, adding your own code and stripping it down to an absolute minimum needed to demonstrate the bug.

Prettier

This project use Prettier for its code formatting. The goal is to be sure that all code pushed to this repository has the same style. A git hook is set up to format all the edited files on commit.

Submittting a Pull Request

To contribute to the project, please follow these steps:

  1. Get approval for the idea by filing an issue and talking with me about the changes
  2. Fork the repo
  3. Make a branch for your change
  4. Run npm install
  5. Run npm run test
  6. Make your changes
  7. Test your changes (if you need a new test file, please copy the test-template.js file in the tests/specs folder.)
  8. Run npm run build to generate the dist files
  9. Run git add -A to add your changes
  10. Run npm run commit (Do not use git commit) - follow the prompts to create your git message
  11. Push your changes with git push
  12. Create the Pull Request (a demo showing what the PR does is always good so you can fork this fiddle)
  13. If there are several commits, please rebase and squash everything to only get one commit.
  14. Get merged and celebrate

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub