Contributing

How to contribute to the MUDE Music Player project

Thank you for considering contributing to MUDE! We welcome contributions from the community to help make this music player even better.

Ways to contribute

You can help improve the project in several ways:

Adding new features

Have a new idea? Feel free to discuss and implement it! We’re open to new features that enhance the music listening experience in VS Code.

Fixing bugs

Found a bug? Report it and fix it! Bug fixes are always appreciated and help make MUDE more stable for everyone.

Improving the code

This started as a personal project, so there are many areas where the code can be improved. Feel free to:

• Refactor existing code for better readability
• Improve error handling
• Add type safety improvements
• Optimize performance
• Enhance documentation

Getting started

Before you start contributing, make sure to:

1. Fork the repository

   Fork the MUDE repository to your GitHub account.

2. Clone your fork

   Clone your fork to your local machine:

   git clone https://github.com/YOUR_USERNAME/MUDE-music-in-vscode.git
   cd MUDE-music-in-vscode
   
3. Install dependencies

   Install the required dependencies:

   npm install
   
4. Create a branch

   Create a new branch for your feature or fix:

   git checkout -b feature/your-feature-name
   

Code guidelines

• Write clear, readable code
• Follow the existing code style
• Add comments for complex logic
• Test your changes thoroughly
• Make sure the extension builds without errors

Submitting changes

1. Commit your changes

   Commit your changes with a clear commit message:

   git add .
   git commit -m "Add: description of your changes"
   
2. Push to your fork

   Push your changes to your fork:

   git push origin feature/your-feature-name
   
3. Create a pull request

   Create a pull request from your fork to the main repository. Provide a clear description of:

   • What changes you made
   • Why you made them
   • Any issues your PR addresses

Code of conduct

At the end of the day, we are all just 1’s and 0’s - just make sure you don’t break the code! 😊

Questions?

If you have questions about contributing, feel free to:

• Open an issue on GitHub
• Check the architecture documentation to understand the codebase
• Review the building guide for development setup

We appreciate your contributions! 🙏