Skip to content

updates CONTRIBUTING.md #1089

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
daneden merged 4 commits into from
Aug 13, 2020
+15 −0
Merged

updates CONTRIBUTING.md #1089

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a838650
updates CONTRIBUTING.md
anthony0030 Aug 7, 2020
1966a62
Updates documentation to mention the config files
anthony0030 Aug 12, 2020
f8a2597
updates branch name
anthony0030 Aug 12, 2020
de43da2
updates documentation regarding linting
anthony0030 Aug 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,18 @@ The animations in Animate.css should follow a few key principles:
- **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.
- **Animations should feel familial.** Avoid introducing animations that feel out-of-place compared to the existing set.
- **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.

## Code Styling
Comment thread
anthony0030 marked this conversation as resolved.

1. Match the naming convention (camelCase, categorized [fades, bounces, etc])
2. Indent with two spaces
3. End each file with a blank line
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.

## How To Contribute

1. [Fork](https://help.github.com/articles/fork-a-repo/) the project
2. Create a new topic branch on your local forked copy
3. Push your topic branch up to your fork
4. Create a [pen](https://codepen.io/) demonstrating what yor change will do.
5. [Open a Pull Request](https://help.github.com/articles/about-pull-requests/) with a clear title and description against the `main` branch.