Contributing
Want to collaborate? Learn how.
Weave.js is an open-sourced and growing project, and we welcome contributions from developers, designers, technical writers, and the broader community!
Your ideas, improvements, bug fixes, and new features help make Weave.js better, stronger, and more useful for all the community.
This section explains how external collaborators can get involved, collaborate with the project, and make an impact.
Ways to Collaborate
| Area | How You Can Contribute |
|---|---|
| Code Contributions | Fix bugs, improve performance, build new features, or extend plugin and store support. |
| Documentation | Help us improve or expand the docs: quickstarts, tutorials, architecture deep-dives, or translations. |
| Testing and QA | Try new releases, report issues, suggest improvements for usability, performance, or developer experience. |
| Ideas and Proposals | Suggest new tools, plugins, integrations, or use cases by opening discussions. |
| Community Engagement | Answer questions, write blog posts or tutorials about Weave.js, help other developers get started. |
How to start contributing
- Check the open issues: browse the GitHub Issues to find open bugs, enhancement requests, or tasks labeled "candidate".
- Fork the repository: fork the Weave.js GitHub repository and create a new branch for your contribution.
- Follow the development guidelines: please read the CONTRIBUTING.md file for coding standards, commit style, and pull request best practices.
- Submit a pull request: open a pull request (PR) with a clear description of what you changed or added. The core team will review it, suggest feedback if necessary, and merge when ready.
If you're more visual, here's a flowchart for the collaboration process:
General Guidelines
- Keep changes small and focused whenever possible.
- Always write clear commit messages and link related issues in PRs.
- Prefer discussion first for larger features or architectural changes.
- Be respectful, inclusive, and patient — we're all building something great together!
Why Collaborate with Weave.js?
- Work on a cutting-edge real-time collaboration framework.
- Learn or improve skills around CRDTs, WebSockets, React, Canvas APIs, and scalable architectures.
- Grow your open-source contribution profile.
- Help shape the future of collaborative and visual tools on the web.
Weave.js is a community effort.
We believe that the best tools are built together — and we would love for you to be part of this journey. No contribution is too small — even a typo fix matters!