Skip to content

Latest commit

 

History

History
150 lines (99 loc) · 4.67 KB

File metadata and controls

150 lines (99 loc) · 4.67 KB

Contributing to WoW Emulation Projects 🌟

Welcome, Friend! 🎉

All contributions are welcome! 😃 First day in Open Source? Perfect! You belong here!

We're not looking for perfection - we're looking for people who care. If you love these classic games and want to help preserve them, you're already qualified! 💚

🤗 Who We Are

We're just gamers who want to keep enjoying the games we love, learning and growing together along the way. Nobody here knows everything, and that's what makes it fun!

🌱 Your First Contribution? Start Here

Remember: No question is too small, no contribution too minor!

Step 1: Get Comfortable 🛋️

  • Join our community discussions and say hello! 👋
  • Read through some existing issues to get a feel for things
  • Don't understand something? Ask! We love questions!

Step 2: Find Your First Task 🎯

  • Look for issues labeled good first issue 🏷️
  • Found something interesting? Comment on it!
  • Want to work on something not listed? Propose it!

Step 3: Make Your Magic Happen ✨

  1. Fork the repository
  2. Create your feature branch (git checkout -b my-awesome-feature)
  3. Make your changes (take your time!)
  4. Commit with a clear message (see below for tips)
  5. Push to your branch
  6. Open a Pull Request - we'll guide you from there!

Stuck at any step? That's normal! Drop a message in discussions and we'll help! 🤝

⏰ When to Expect Responses

Our team is mostly active on weekends 🗓️, so:

  • Weekday submissions: Expect responses by the weekend
  • Weekend submissions: Usually get same-day attention
  • Urgent security issues: We'll prioritize these!

Your patience makes our community sustainable! 🌻

🐛 Reporting Issues

Found a bug? Have an idea? Awesome! Here's how to share it:

Writing a Great Issue 📝

  • Use our templates - they're there to help you!
  • Describe what you expected vs. what happened
  • Include steps to reproduce (if it's a bug)
  • Screenshots are super helpful! 📸
  • Not sure about something? Just do your best!

Remember: The "perfect" issue doesn't exist

Your report helps us improve! 🌟

🚀 Pull Requests

Making Your PR Shine ✨

  • No perfection required! We'll help you polish it
  • Describe what you changed and why
  • Tell us how to test your changes
  • First PR? Add "First PR" to your description - we'll give extra guidance! 🎓
  • Made a mistake? No worries! PRs are conversations, not tests

What Happens Next? 🤔

  1. A friendly contributor will review your PR
  2. They might suggest some tweaks (it's all about learning!)
  3. You make the changes (or discuss alternatives)
  4. We merge and celebrate! 🎉

💬 Git Commit Messages Made Easy

We use Conventional Commits - it's simpler than it sounds! Here are examples:

The Basics 📚

  • feat: Adding something new
    • Example: feat: add dark mode toggle to settings
  • fix: Fixing a bug
    • Example: fix: correct database connection timeout
  • docs: Documentation changes
    • Example: docs: update installation instructions
  • chore: Maintenance tasks
    • Example: chore: update dependencies

Pro Tips 💡

  • Keep it short and sweet (under 50 characters)
  • Use present tense ("add" not "added")
  • No period at the end
  • Explain the "why" in the PR description

Messed up a commit message? It happens to all of us

We can fix it together! 🤝

📚 Learning Resources

New to Git? 🆕

Want to Level Up? 📈

🎮 Types of Contributions We Love

  • Code - Features, bug fixes, optimizations
  • Documentation - Tutorials, clarifications, translations
  • Testing - Bug reports, test cases, gameplay testing
  • Ideas - Feature requests, brainstorming, feedback
  • Community - Helping others, answering questions, being kind
  • Art & Design - Icons, screenshots, improving UI/UX

Your unique perspective makes our community better! 🌈

💖 Our Commitment to You

  • We'll treat you with respect and kindness
  • We'll help you learn and grow
  • We'll celebrate your contributions
  • We'll make this a safe space for everyone

Ready to contribute? You've got this

And remember, we're here to help every step of the way! 🚀