Thank you for your interest in contributing! We're looking for people interested in the vision of Eclaire and willing to help. Have a look at the Roadmap, GitHub Issues, or feel free to suggest features or fixes. There are areas for improvement across the whole stack. We're also open to integrating or partnering with other open source projects that are building pieces that can augment, complement, or replace some of the existing building blocks in Eclaire.
After pulling changes from the repository, always update your dependencies:
git pull
pnpm install # Updates dependencies to match the lockfileThis ensures your local environment matches the project's dependency requirements, especially after workspace configuration changes.
- Run
pnpm formatto format your code - Follow existing patterns and conventions in the codebase
- Write descriptive commit messages
- Add or update tests when introducing new features or bug fixes
- Ensure all existing tests pass locally
- Run the full suite with
pnpm test
- Keep PRs focused on a single concern
- Provide a clear description of your changes
- Reference any related issues
- Make sure all checks pass (formatting, tests, CI)
- Request a review from maintainers
Smaller, focused PRs are easier to review and merge.
- Use GitHub Issues for bugs and feature requests
- Choose the appropriate issue template
- Include as much detail as possible (steps to reproduce, logs, etc.)
- Search existing issues first to avoid duplicates
By contributing, you agree that your contributions are licensed under the same license as this repository (MIT).
If you have questions, feel free to:
- Open an issue for discussion
- Reach out to the maintainers
Thanks for helping improve the project!