Skip to content

Commit

Permalink
📝 make small updates to contribution docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bryanbraun committed Feb 1, 2024
1 parent c463f9f commit 7f2f5ca
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Hey! You're thinking about contributing? That's awesome! You're awesome.
Here's a few things you should know before you submit your PR:

1. Bouncy Ball is a curation, not a collection. Not every technique makes sense in this format. For example, submissions using immature libraries, unstable APIs, or slight variations on existing techniques probably wouldn't be accepted.
2. New animation code should not require a build/compile step. For example, you'll want to use CSS instead of SCSS and browser-compatible ES5 instead of transpiled ES6.
3. Write concise, clean code. For style recommendations, check out [AirBnB's ES5 Javscript Styleguide](https://github.com/airbnb/javascript/tree/b4d8543f120ba761ae7f39caf850c1e4efdc2727/es5).
2. New animation code should not require a build/compile step. For example, you'll want to use CSS instead of SCSS and browser-compatible JavaScript instead of Typescript.
3. Write concise, clean code. For style recommendations, check out [AirBnB's JavaScript Styleguide](https://github.com/airbnb/javascript/tree/b4d8543f120ba761ae7f39caf850c1e4efdc2727/es5).
4. Any new animation should work on the demo page and be visually indistinguishable from existing animations (except for the color of the ball).
5. Please test your animation across modern browsers. If some browsers don't support the animation, ensure the incompatibilty message is displayed.
6. The browser compatibility requirement for the bouncy-ball site itself is modern browsers (Edge, Chrome, Firefox, and Safari).
Expand Down

0 comments on commit 7f2f5ca

Please sign in to comment.