Open issues can be found on our GitHub issues page with a "Bug" label.
These are a great place to start contributing to the repo!
Once you start work on a bug, post your intent on the issue itself. This will prevent more than one person working on it at once.
If the bug you want to work on doesn't have a related issue, open one, and attach the "Bug" label.
Before adding any features, open a Feature Proposal.
This will let us talk through your proposal API and/or implementation before you spend time on it.
An added caveat is that this API is ultimately consumed by the Library in Framer X, so our target audience is designers as well as developers. This can tend us towards simplicity and power over composability.
If a PR introduces or changes API, it should link to a sister PR on the API docs repo.
Follow these steps to get your code PR-ready:
- Fork the Motion repo.
- Clone your fork to your local computer.
- Install Yarn.
- Run
make bootstrapin the repo root. - Add your code and supporting tests.
- If this is a feature that requires doc changes, make as necessary.
- Update CHANGELOG.md. Follow the existing format.
- You're ready!