Thank you for your interest in contributing to QMD! This document provides guidelines for contributing to the project.
- Fork the repository
- Clone your fork locally
- Create a new branch for your feature or bug fix
- Make your changes
- Test your changes thoroughly
- Submit a pull request
- Follow the existing code style and conventions
- Use meaningful variable and function names
- Add comments for complex logic
- Ensure your code is properly formatted
- Ensure your code follows the project's style guidelines
- Update documentation if necessary
- Add tests for new functionality
- Ensure all tests pass
- Create a clear and descriptive pull request title
- Provide a detailed description of your changes
When reporting issues, please include:
- Clear description of the problem
- Steps to reproduce
- Expected vs actual behavior
- Environment details (OS, browser, etc.)
- Screenshots if applicable
If you have questions about contributing, please open an issue or reach out to the maintainers.