Contributor Rulebook
Before you code, read the rules. How we work together on Babelize Elements.
Before you code, read the rules.
Eight rules for contributing to Babelize Elements. Also available as a PDF.
01 · Talk before you code
Found a bug? Have an idea? Want to build a feature? Don't start coding yet.
Avoid duplicate work.
Keep contributions coordinated.
02 · Open a PR
One PR. One clear change. Keep your PR:
Focused
Solve one problem. Scope your changes to a single issue or feature.
Clear
Explain what changed and why. Add context, screenshots if needed, and link the issue.
Tested
Make sure your code works as expected and doesn't break existing functionality.
Reviewable
Keep it small and clean. No formatting changes or unrelated refactors.
Small, focused PRs are easier to review.
They keep history clean and get merged faster.
03 · Code quality
Write code we can maintain. Before opening your PR:
Follow existing patterns
Keep code consistent with the project.
Keep components reusable
Build flexible, composable parts.
Use consistent naming
Follow the naming conventions.
Avoid extra dependencies
Keep the project lightweight.
Handle edge cases
Think about error states and scenarios.
Remove unused code
Keep the codebase clean and minimal.
Test your changes
Make sure everything works.
Update docs when needed
Help others understand your changes.
New component? Start from the component template.
Readable > clever.
Write code for humans, not just machines.
04 · PR review
A PR isn't the finish line.
Reviewers may request:
Code changes
Refine the implementation or fix issues.
Additional tests
Add or improve test coverage.
Documentation updates
Update docs, comments, or READMEs.
Clarification
Provide more context or explanation.
Different approaches
Discuss alternative solutions.
Feedback is part of contributing.
Be open, be responsive, keep it constructive.
05 · Community guidelines
Build with people, not just code.
Be respectful
Treat contributors and maintainers with respect.
Be constructive
Point out problems and help find solutions.
Give context
Explain your reasoning.
Help others
Share what you know.
Keep it focused
Keep discussions relevant.
See also our Code of Conduct.
Good code matters.
Good collaboration matters too.
06 · Star & fork
Support the project.
Star the repo
A star shows your support and helps more developers discover Babelize Elements.
Fork the repo
Your own copy to experiment, make changes, and open PRs.
git clone https://github.com/<your-username>/babelize-elements.git
cd babelize-elementsSmall actions. Big impact.
Let's build a more inclusive internet together.
07 · Join the community
Don't build alone. Join the Babelize Discord and head to the #elements channel for:
Questions
Ask and get help from others.
Ideas
Share ideas and suggestions.
Contributions
Pick up issues and contribute.
Feedback
Help us grow.
Issues
Report bugs and discuss fixes.
Getting help
Stuck? Ask the community.
Your contribution starts with a conversation.
Ideas grow faster together.
08 · Start contributing
Ready to build?
good first issue.Open source. More people.
A more global future. Build with us.