Skip to content

Commit ee623bd

Browse files
authored
Merge pull request #1089 from anthony0030/documentation
updates CONTRIBUTING.md
2 parents 68c87c9 + de43da2 commit ee623bd

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,18 @@ The animations in Animate.css should follow a few key principles:
1414
- **Animations should be helpful.** They should be designed to guide users to a point of interest, ease natural reading order, or to communicate relationships between elements.
1515
- **Animations should feel familial.** Avoid introducing animations that feel out-of-place compared to the existing set.
1616
- **Animations should feel natural.** Animations should reflect, as much as is reasonable, motion that occurs in natural physics. Avoid extreme timing functions, and model animations on real-world events.
17+
18+
## Code Styling
19+
20+
1. Match the naming convention (camelCase, categorized [fades, bounces, etc])
21+
2. Indent with two spaces
22+
3. End each file with a blank line
23+
4. Make sure you have an editorconfig plugin/extension enabled in your editor and all the dependencies installed so editorconfig and prettier can automatically format your code when committing.
24+
25+
## How To Contribute
26+
27+
1. [Fork](https://help.github.com/articles/fork-a-repo/) the project
28+
2. Create a new topic branch on your local forked copy
29+
3. Push your topic branch up to your fork
30+
4. Create a [pen](https://codepen.io/) demonstrating what yor change will do.
31+
5. [Open a Pull Request](https://help.github.com/articles/about-pull-requests/) with a clear title and description against the `main` branch.

0 commit comments

Comments
 (0)