Thank you for your interest in contributing to WAV0! We're building the future of AI-native audio production and sound design, and your contributions help make high-quality production accessible to everyone.
- Bun (recommended) or Node.js 18+
- Git
- A modern web browser
- Ask questions on Discord - Don't hesitate to reach out! The community is friendly and helpful.
- Explore the codebase - Use your IDE's search to find related code, check existing patterns, and understand the architecture before making changes.
- Start small - Fix typos, improve documentation, or tackle "good first issue" labels to get familiar with the codebase.
- Read the docs - Check AGENTS.md and CLAUDE.md for detailed development guidelines and patterns.
See AGENTS.md for development guidelines and the .cursor/rules folder for more detailed guidelines.
We use Biome for linting and formatting:
bun lint # Check for issues
bun lint:fix # Auto-fix issues
bun format # Format code- Use strict TypeScript
- Prefer
typeoverinterfacefor component props - Use absolute imports with
@/alias - Separate type imports:
import type { Props } from '...'
- Use functional components with arrow functions
- Prefer Server Components over Client Components when possible
- Use
useCallbackanduseMemofor performance optimization - Follow the component structure: exported component, subcomponents, helpers, types
AI use is accepted and encouraged for productivity, but no slop allowed. Quality over speed.
Cursor (Recommended)
- Use Plan Mode first to understand the approach
- Then use Build Mode to implement
- Ask questions and understand changes before committing
- Leverage features like Agent Review and Bugbot for code quality checks
Code Review Tools
- Use tools like CodeRabbit and similar AI code review assistants
- Don't blindly accept suggestions—review and understand them
Before submitting PRs:
- ✅ Run
bun lintand fix all issues - ✅ Run
bun check-typesto ensure no TypeScript errors - ✅ Run
bun buildto verify the project builds successfully - ✅ Run
bun testif tests exist - ✅ Review your diff for AI-generated slop
We have a deslop command in .cursor/commands/ to help clean up AI-generated code issues:
- Extra comments that a human wouldn't add or are inconsistent with the codebase
- Unnecessary defensive checks or try/catch blocks in trusted codepaths
- Type casts to
anyto bypass type issues - Any style inconsistencies with the rest of the file
Always review AI-generated code—understand what it does, ensure it matches our patterns, and remove slop before committing.
git checkout -b feature/your-feature-name
# or
git checkout -b fix/issue-description- Write clean, readable code
- Add comments for complex logic
- Update documentation if needed
- Test your changes thoroughly
We use conventional commits:
git commit -m "feat: add new audio effect to DAW"
git commit -m "fix: resolve playback issue in Safari"
git commit -m "docs: update API documentation"git push origin feature/your-feature-nameThen create a pull request with:
- Clear description of changes
- Screenshots/videos if UI changes
- Link to related issues
- Test results
- Accessibility First: Follow WCAG guidelines, ensure keyboard navigation
- Mobile Responsive: Design for mobile-first, then enhance for desktop
- Performance: Optimize for speed and smooth interactions
- Consistency: Use our design system and component library
- Immediate Feedback: Audio changes should be instant
- Visual Clarity: Clear visual representation of audio data
- Error Prevention: Prevent destructive actions, provide undo options
- Workflow Efficiency: Minimize clicks and steps to common tasks
- Focus on browser compatibility
- Optimize for real-time performance
- Consider memory usage for large audio files
- Test across different audio formats
- Maintain professional DAW standards
- Ensure precise timing and synchronization
- Support common keyboard shortcuts
- Provide visual feedback for all interactions
When reporting bugs, please include:
- Clear Description: What happened vs. what you expected
- Steps to Reproduce: Detailed steps to recreate the issue
- Environment: Browser, OS, WAV0 version
- Screenshots/Recordings: Visual evidence of the issue
- Console Logs: Any error messages or warnings
When suggesting features:
- Problem Statement: What problem does this solve?
- Proposed Solution: How should it work?
- Use Cases: Specific scenarios where this would be helpful
- Priority: How important is this to your workflow?
We use act to test GitHub Actions workflows locally. Install Docker and act, then:
# Test CI workflow
act -W .github/workflows/ci.yml -P ubuntu-latest=catthehacker/ubuntu:act-latest
# Test deploy workflow (use --dryrun first!)
act push -W .github/workflows/deploy-convex.yml --dryrunSee act documentation for full usage.
- Discord: Join our community
- Twitter: @wav0ai
By contributing to WAV0, you agree that your contributions will be licensed under the MIT License.
Contributors will be recognized in our:
- README.md contributors section
- Release notes
- Community highlights
Thank you for helping make audio creation accessible to everyone! 🎵