Contributing
How to contribute to Turbo Themes.
Contributing to Turbo Themes
Thank you for your interest in contributing! This guide will help you get started.
Ways to Contribute
Report Issues
Found a bug or have a feature request? Open an issue on GitHub.
When reporting bugs, please include:
- Your browser/environment
- Steps to reproduce
- Expected vs actual behavior
- Screenshots if applicable
Submit Pull Requests
We welcome code contributions! Before starting work:
- Check existing issues to avoid duplicate work
- For large changes, open an issue first to discuss
- Follow the coding standards below
Improve Documentation
Documentation improvements are always welcome:
- Fix typos or clarify confusing sections
- Add examples or use cases
- Translate documentation
Quick Start
# Fork and clone the repo
git clone https://github.com/YOUR-USERNAME/turbo-themes.git
cd turbo-themes
# Install dependencies
bun install
# Start development server
bun run dev
# Run tests
bun run test
Repository Structure
turbo-themes/
โโโ packages/
โ โโโ core/ # Design tokens and theme definitions
โ โโโ css/ # CSS generation
โ โโโ theme-selector/ # Theme selector component
โ โโโ adapters/ # Framework adapters (Tailwind, Bulma)
โโโ apps/
โ โโโ site/ # Documentation site (Astro)
โโโ python/ # Python package
โโโ swift/ # Swift package
โโโ docs/ # Additional documentation
โโโ test/ # Test suites
Guidelines
Code Style
- Use TypeScript for JavaScript code
- Follow existing code patterns
- Run
bun run lintbefore committing - Add tests for new functionality
Commit Messages
Follow Conventional Commits:
feat: add new theme variant
fix: correct contrast ratio in Dracula theme
docs: update installation guide
chore: update dependencies
Pull Request Process
- Create a feature branch from
main - Make your changes
- Run tests:
bun run test - Run linting:
bun run lint - Push and open a PR
- Fill out the PR template
- Wait for review
Next Steps
- Set up your Development Environment
- Learn about Testing
- Understand the Release Process