Contributing to Relottie
Learn how to contribute to the Relottie project. Find guidelines for reporting bugs, submitting code, and improving documentation for this Lottie tool.
Contributing to Relottie
Contributions to the relottie project are welcome! Whether it's reporting bugs, suggesting features, improving documentation, or submitting code changes, your help is appreciated.
Getting Started with Development
The relottie project is managed as a monorepo using pnpm workspaces.
1. Clone the Repository
git clone https://github.com/LottieFiles/relottie.git
cd relottie2. Install Dependencies
Use pnpm (ensure it's installed: npm install -g pnpm) to install dependencies across all packages in the monorepo.
pnpm install3. Common Development Scripts
The following scripts (run via pnpm <script-name>) are available at the root of the monorepo, based on the source documentation:
pnpm dev: Run in development mode (details depend on specific package setup, likely involves watching files and rebuilding).pnpm test: Run the test suite for all packages.pnpm build: Build all packages for production/distribution.pnpm lint: Run the code linter to check for style and potential errors.pnpm changelog: Add a changelog entry using Changesets. This is typically done when making a code change that requires a version bump.
Contribution Guidelines
While the source documentation provides the setup steps, general contribution guidelines often include:
Reporting Issues: Use GitHub Issues to report bugs or suggest features. Provide clear steps to reproduce bugs.
Pull Requests: For code changes, fork the repository, create a feature branch, make your changes (including tests and changelog entries if applicable), and submit a Pull Request.
Code of Conduct: Adhere to the project's code of conduct (usually linked in the main repository README or CONTRIBUTING file).
Commit Messages: Follow conventional commit message formats if the project uses them.
(Please refer to the main CONTRIBUTING.md file in the Relottie GitHub repository for the most up-to-date and detailed contribution guidelines.)
Community & Support
Engage with the community and get support through:
GitHub Issues: For bug reports and feature requests related to relottie.
LottieFiles Discord: General discussion about Lottie, sharing animations, and community interaction.