Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (51 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

67 lines (51 loc) · 1.39 KB

Contributing to Whisper Notes Pro

Hey there! 👋 Thanks for considering contributing to Whisper Notes Pro. We're excited to have you here!

Quick Start

  1. Fork the repo
  2. Clone your fork
  3. Create a branch for your changes
  4. Make your awesome changes
  5. Submit a PR

Development Setup

# Get the code
cd whisper-notes/app
pnpm install
pnpm run download-model  # Important! You need this for speech recognition
pnpm tauri dev

Guidelines

Keep it Simple

  • Focus on one feature/fix per PR
  • If you're adding a feature, update the README
  • Test your changes before submitting

Code Style

  • Follow the existing code style
  • Use meaningful variable/function names
  • Add comments for complex logic

Commit Messages

Keep them clear and descriptive. For example:

  • ✨ Add dark mode support
  • 🐛 Fix audio recording on M1 Macs
  • 📝 Update documentation

What We Love to See

  • Bug fixes
  • Performance improvements
  • New features
  • Documentation improvements
  • UI/UX enhancements

Need Help?

  • Open an issue for discussion
  • Ask questions in your PR
  • Tag maintainers if you're stuck

Pull Request Process

  1. Update the README.md if needed
  2. Test your changes
  3. Push to your fork
  4. Create a Pull Request
  5. Wait for review

Code of Conduct

  • Be nice and respectful
  • Help others when you can
  • Have fun building cool stuff!

That's it! Thanks for contributing! 🎉