Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

38 lines (26 loc) · 1.4 KB
Raw

Contribution Guidelines

Hey there! Welcome to Hacktoberfest Animations! Here you can create your very own animation and share it with the world! Please read the code of conduct.

How to add your animation

  • Fork this repo
  • Create a new CSS file with your cool animation name inside ./animations folder, be creative!
  • Edit the ./animations.js file to include your animation using the following structure:
{
    name: 'the-name-of-your-animation',
    author: 'your-github-username'
}

PS: the animation name should have the same name of your CSS file.
PS²: although it is not necessary to include your object alphabetically (there is a function that will do this automatically afterwards), it is recommended that you do so to keep the project organized.
PS³: use the same name of your CSS file as your animation class. Example: a file named my-cool-animation.css containing a .my-cool-animation class inside.

  • DONE!

How to submit a pull request

  • Fork this repo
  • Follow the guide on how to create your own animation
  • Push the changes to your forked version of the repo
  • Submit a pull request!

Other contributions

Other contributions can be made to the repo such as:

  • UI changes or fixes
  • Documentation corrections or amendments