CONTRIBUTING Copy Section

Contributing

Thanks for your interest in contributing to motion-primitive. We're happy to have you here.

Please take a moment to review this document before submitting your first pull request. We also strongly recommend that you check for open issues and pull request to see if someone else is working on something similar.

If you need any help, feel free to reach out to @ibelick.

About this repository Copy Chapter

- We use npm.
- For animation framer
- For custom icons lucid react

Development Copy Chapter

Fork this repo Copy Section

You can fork this repo by clicking the fork button in the top right corner of this page.

Clone on your local machine Copy Section

git clone https://github.com/ibelick/motion-primitives.git

Navigate to project directory Copy Section

cd motion-primitives

Create a new Branch Copy Section

git checkout -b my-new-branch

Install dependencies Copy Section

npm install

Commit Convention Copy Chapter

Before you create a Pull Request, please check whether your commits comply with
the commit conventions used in this repository.

When you create a commit we kindly ask you to follow the convention
category(scope or module): message in your commit message while using one of
the following categories:

- feat / feature: all changes that introduce completely new code or new
features
- fix: changes that fix a bug (ideally you will additionally reference an
issue if present)
- refactor: any code related change that is not a fix nor a feature
- docs: changing existing or creating new documentation (i.e. README, docs for
usage of a lib or cli usage)
- build: all changes regarding the build of the software, changes to
dependencies or the addition of new dependencies
- test: all changes regarding tests (adding new tests or changing existing
ones)
- ci: all changes regarding the configuration of continuous integration (i.e.
github actions, ci system)
- chore: all changes to the repository that do not fit into any of the above
categories

e.g. feat(components): add new prop to the avatar component

If you are interested in the detailed specification you can visit
https://www.conventionalcommits.org/ or check out the
Angular Commit Message Guidelines.

Requests for new components Copy Chapter

If you have a request for a new component, please open a discussion on GitHub. We'll be happy to help you out.

---

README Copy Section

Motion-Primitives

Beautifully designed, easy-to-integrate motion components for engineers and designers, built with motion and Tailwind CSS.

This project is in beta. Expect new components to be released regularly and significant updates to the code.

<p align="center">
<img src="https://raw.githubusercontent.com/ibelick/motion-primitives/main/app/opengraph-image.jpg" alt="hero" width="80%" />
</p>

Documentation Copy Chapter

Visit motion-primitives.com/docs to view the full documentation.

Contributing Copy Chapter

Please read the contributing guide.

License Copy Chapter

Licensed under the MIT license.

---