Skip to content

Latest commit

 

History

History
100 lines (73 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

100 lines (73 loc) · 2.85 KB

Contributing to M3Unator

Development Setup

  • Updated build requirements
  • Enhanced testing environment
  • Performance monitoring tools

Code Standards

  • Class-based architecture
  • Modular code structure
  • Error handling practices
  • Performance optimization guidelines

Testing Guidelines

  • Performance benchmark tests
  • Memory usage tests
  • Web server compatibility tests
  • Character encoding tests

Thank you for your interest in contributing to M3Unator! This document provides guidelines and instructions for contributing to the project.

📋 Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct, which promotes a respectful and inclusive environment for all contributors.

🐛 Bug Reports

  1. Check if the bug has already been reported in Issues
  2. If not, create a new issue using the bug report template
  3. Include detailed steps to reproduce the bug
  4. Add screenshots if applicable
  5. Specify your browser and userscript manager versions

💡 Feature Requests

  1. Check if the feature has already been requested in Issues
  2. If not, create a new issue using the feature request template
  3. Explain the feature's purpose and benefits
  4. Provide examples of how it would be used
  5. Consider implementation details

🔄 Pull Requests

  1. Fork the repository
  2. Create a new branch for your changes
  3. Make your changes following our coding standards
  4. Write or update tests as needed
  5. Update documentation if required
  6. Submit a pull request with a clear description

Commit Messages

  • Use clear and descriptive commit messages
  • Start with a verb in present tense
  • Keep the first line under 50 characters
  • Add details in the body if needed

Example:

Add playlist sorting feature

- Implement alphabetical sorting
- Add reverse sorting option
- Update UI to show sort direction

🧪 Testing

  • Write tests for new features
  • Update existing tests when modifying features
  • Ensure all tests pass before submitting
  • Add test cases for bug fixes

📚 Documentation

  • Update README.md for user-facing changes
  • Update DEVELOPMENT.md for developer-facing changes
  • Keep documentation clear and concise
  • Include code examples where helpful

🔍 Code Review Process

  1. Maintainers will review your PR
  2. Address any requested changes
  3. Once approved, your PR will be merged
  4. Your contribution will be added to CHANGELOG.md

⭐ Recognition

  • Contributors are recognized in release notes
  • All contributors are valued members of our community
  • Significant contributions are highlighted in project updates

📞 Questions?

  • Open a Discussion
  • Ask in the relevant issue
  • Contact maintainers through GitHub

Thank you for contributing to M3Unator! 🎉