Take control of your CSS keyframe animations

jogwheel

Yeay! You want to contribute to jogwheel. That's amazing! To smoothen everyone's experience involved with the project please take note of the following guidelines and rules.

Found an Issue?

Thank you for reporting any issues you find. We do our best to test and make jogwheel as solid as possible, but any reported issue is a real help.

jogwheel issues

Please follow these guidelines when reporting issues:

• Provide a title in the format of <Error> when <Task>
• Tag your issue with the tag bug
• Provide a short summary of what you are trying to do
• Provide the log of the encountered error if applicable
• Provide the exact version of jogwheel. Check npm ls jogwheel when in doubt
• Be awesome and consider contributing a pull request

Want to contribute?

You consider contributing changes to jogwheel – we dig that! Please consider these guidelines when filing a pull request:

jogwheel pull requests

• Follow the Coding Rules
• Follow the Commit Rules
• Make sure you rebased the current master branch when filing the pull request
• Squash your commits when filing the pull request
• Provide a short title with a maximum of 100 characters

• Provide a more detailed description containing

      * What you want to achieve
      * What you changed
      * What you added
      * What you removed
  

Coding Rules

To keep the code base of jogwheel neat and tidy the following rules apply to every change

Coding standards

• Happiness enforced via eslint
• Use advanced language features where possible
• JSdoc comments for everything
• Favor micro library over swiss army knives (rimraf, ncp vs. fs-extra)
• Coverage never drops below 90%
• No change may lower coverage by more than 5%
• Be awesome

Commit Rules

To help everyone with understanding the commit history of jogwheel the following commit rules are enforced. To make your life easier jogwheel is commitizen-friendly and provides the npm run-script commit.

Commit standards

• conventional-changelog
• husky commit message hook available
• present tense
• maximum of 100 characters
• message format of $type($scope): $message

jogwheel v1.3.0 is built by Mario Nebl and contributors with :heart: and released under the MIT License.