Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
109 lines (74 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

109 lines (74 loc) · 2.46 KB

🤝 Contributing to MyStats

"This project was built with Vibe Coding — ideas first, perfection later."

Thank you for your interest in contributing! We believe everyone with an idea can make this project better. No gatekeeping. No elitism. Just vibes.

🌟 Philosophy

MyStats was born from Vibe Coding — a development approach where:

  • Speed > Perfection: Ship fast, iterate faster
  • AI-Assisted: We embrace AI tools (Gemini, Cursor, etc.)
  • Ideas Welcome: You don't need to be a 10x dev to contribute

🚀 How to Contribute

💡 Got an Idea?

  1. Open an Issue with [Idea] prefix
  2. Describe the problem you're solving
  3. No code required — we can help implement it!

🐛 Found a Bug?

  1. Check if it's already reported
  2. Open an Issue with reproduction steps
  3. Screenshots welcome

🔧 Ready to Code?

# 1. Fork & Clone
git clone https://github.com/YOUR_FORK/mystats.git
cd mystats

# 2. Install
npm install

# 3. Create branch
git checkout -b feature/your-awesome-feature

# 4. Make changes & commit
git commit -m "feat: add awesome feature"

# 5. Push & PR
git push origin feature/your-awesome-feature

📝 Commit Convention

We use Conventional Commits:

Type Description
feat: New feature
fix: Bug fix
docs: Documentation
style: Formatting (no logic change)
refactor: Code restructure
perf: Performance improvement
chore: Maintenance

Example: feat: add Korean language support

🎨 Code Style

  • TypeScript: Strict mode, no any
  • React: Functional components + hooks
  • Styling: Tailwind CSS with cn() utility
  • Icons: lucide-react only

Don't worry too much — we'll help in PR reviews!

🤖 AI-Assisted Contributions

We welcome AI-generated code! If you used ChatGPT, Gemini, Cursor, or any AI tool:

  • That's totally fine 👍
  • Just make sure it works
  • Mention it in the PR if you want

💬 Need Help?

⭐ Recognition

All contributors get:

  • Listed in README
  • Eternal gratitude
  • Good karma

Don't overthink it. Just ship it. 🚀