Skip to content

Latest commit

 

History

History
118 lines (85 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

118 lines (85 loc) · 2.77 KB

🤝 Contributing to Spotituby

First off, thank you for considering contributing to Spotituby! It's people like you that make Spotituby such a great tool.

Whether you're a seasoned developer or just starting your coding journey, your contributions are welcome here! 🌟

🌱 New to Open Source?

No worries! Here are some ways you can contribute:

  • Report bugs you find 🐛
  • Suggest new features 💡
  • Improve documentation 📝
  • Add comments to confusing code 💭
  • Share how you use Spotituby 🎵

Even if you're just learning to code, your perspective is valuable! We were all beginners once.

🚀 Ways to Contribute

1. Creating Issues

Found a bug? Have an idea? Create an issue! Here's how:

  • 🐛 Bug Reports: Include

    • What happened
    • What you expected to happen
    • Steps to reproduce
    • Screenshots if possible
    • Your system info (OS, Node version, etc.)

  • 💡 Feature Suggestions: Include

    • Clear description of the feature
    • Why it would be useful
    • Any implementation ideas you have

People can vote on suggestions using emoji reactions! 👍 👎 🚀

2. Contributing Code

  1. Fork the repository
  2. Create your feature branch: 
    git checkout -b feature/AmazingFeature
  3. Make your changes
  4. Test your changes
  5. Commit: 
    git commit -m 'Add some AmazingFeature'
  6. Push: 
    git push origin feature/AmazingFeature
  7. Open a Pull Request

3. Improving Documentation

Good documentation helps everyone! You can:

  • Fix typos
  • Add examples
  • Clarify confusing sections
  • Add screenshots or GIFs
  • Translate documentation

🎯 Development Guidelines

Don't worry too much about getting everything perfect! Here are some basic guidelines:

  • Keep code simple and readable
  • Add comments to explain complex parts
  • Test your changes
  • Update documentation if needed

🧪 Testing Your Changes

  1. Install dependencies:

    npm install

  2. Run the app locally:

    node index.js --mode cli

  3. Try different scenarios:

    • Downloading from Spotify
    • Downloading from YouTube
    • Error cases

💬 Questions?

Have questions? Need help? You can:

  • Ask in the issue you created
  • Comment on relevant issues
  • Start a discussion

Remember: There are no stupid questions! 🌈

🌟 Recognition

Contributors are listed in our README.md. All contributions, big or small, are valued!

📜 Code of Conduct

  • Be kind and respectful
  • Welcome newcomers
  • Help others learn
  • Give constructive feedback
  • Have fun! 🎉

🎵 Final Note

Spotituby is a hobby project, but that doesn't mean we can't make it awesome together! Whether you're fixing a typo or adding a major feature, your contribution helps make Spotituby better for everyone.

Happy coding! 🚀