Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
139 lines (104 loc) · 3.23 KB

CONTRIBUTING.md

File metadata and controls

139 lines (104 loc) · 3.23 KB

Contributing to LaunchMVP

Thank you for your interest in contributing to LaunchMVP! This template has helped hundreds of developers launch their MVPs, and we'd love your help making it even better.

🚀 Quick Start for Contributors

1. Fork the Repository

Click the "Fork" button on GitHub to create your own copy.

2. Clone Your Fork

git clone https://github.com/YOUR_USERNAME/launch-mvp-stripe-nextjs-supabase.git
cd launch-mvp-stripe-nextjs-supabase

3. Install Dependencies

npm install

4. Set Up Environment

cp .env.example .env.local
# Fill in your Supabase and Stripe keys

5. Create a Branch

git checkout -b feature/your-amazing-feature
# or
git checkout -b fix/bug-description

6. Make Your Changes

  • Write clean, readable code
  • Add comments for complex logic
  • Follow existing code style

7. Test Your Changes

npm run build    # Ensure it compiles
npm run dev      # Test locally

8. Commit Your Changes

git add .
git commit -m "feat: add amazing new feature"
# or
git commit -m "fix: resolve issue with auth"

Commit Message Format:

  • feat: - New feature
  • fix: - Bug fix
  • docs: - Documentation changes
  • refactor: - Code refactoring
  • style: - Formatting, no code change
  • test: - Adding tests

9. Push and Create Pull Request

git push origin feature/your-amazing-feature

Then go to GitHub and click "Create Pull Request"

🎯 Good First Issues

New to contributing? Look for issues labeled:

  • good first issue - Beginner-friendly tasks
  • help wanted - Tasks we'd love help with
  • documentation - Help improve our docs

💡 What We're Looking For

High-Impact Contributions

  • 📧 New email templates (e.g., password reset, invoice)
  • 🎨 UI/UX improvements
  • 📱 Mobile responsiveness fixes
  • 🔒 Security enhancements
  • 📚 Documentation improvements
  • 🐛 Bug fixes

Feature Ideas

  • Additional payment providers
  • More authentication methods
  • i18n/internationalization
  • Dark mode improvements
  • Accessibility (a11y) improvements

📋 Pull Request Guidelines

  1. Keep PRs focused - One feature or fix per PR
  2. Update documentation - If your change affects the README
  3. Test thoroughly - Make sure npm run build passes
  4. Describe your changes - Explain what and why in the PR description
  5. Link related issues - Use "Fixes #123" in your PR description

🤝 Code of Conduct

  • Be respectful and inclusive
  • Welcome newcomers
  • Give constructive feedback
  • Focus on the code, not the person

💬 Questions?

🙏 Thank You!

Every contribution matters, whether it's:

  • Fixing a typo
  • Improving documentation
  • Adding a new feature
  • Reporting a bug

You're helping developers around the world launch their ideas faster. Thank you! 🚀

Made with ❤️ by Sean Chen and the community