Contributing to Solidiom
Solidiom is developed on GitHub. Contributions are welcome across code, documentation, accessibility evidence, and translations.
Getting Started
- Fork the repository on GitHub
- Clone your fork and install dependencies:
git clone https://github.com/<your-username>/solidiom.git
cd solidiom
pnpm install- Create a feature branch:
git checkout -b feat/my-featureDevelopment Workflow
pnpm run build # Build all packages
pnpm run typecheck # Type-check the workspace
pnpm run test # Run unit tests
pnpm run test:browser # Run browser tests
pnpm run lint # Lint the workspaceWhat You Can Contribute
- Primitives: New headless components following the primitive DoD (§8.1)
- Recipes: Styling recipes for CSS, Tailwind, or UnoCSS profiles
- Documentation: Improvements to guides, API docs, or translations
- Accessibility: Keyboard audit records, screen reader testing, evidence
- Bug fixes: Issues labeled
good first issueare a great starting point - Templates: New application templates following §8.4
Guidelines
- All code must pass
pnpm run typecheckandpnpm run test - Use Solidiom primitives for interactive behavior (no duplicate state machines)
- Follow the bilingual documentation requirement (English + Spanish)
- Include accessibility evidence for any new interactive primitive
- Use
pnpm changesetto document user-facing changes
Code of Conduct
We follow the Contributor Covenant. Be respectful, inclusive, and constructive.
Communication
- Issues: Bug reports and feature requests on GitHub Issues
- Discussions: Architecture and design discussions on GitHub Discussions
- Pull Requests: All contributions go through PR review