# Contributing to Quizzical Beats Thank you for considering contributing to Quizzical Beats! We welcome contributions of all kinds, including bug fixes, new features, documentation improvements, and more. ## How to Contribute 1. **Fork the Repository**: Start by forking the repository to your GitHub account. 2. **Clone Your Fork**: Clone your forked repository to your local machine: ```bash git clone https://github.com/christianlouis/QuizzicalBeats.git cd QuizzicalBeats ``` 3. **Set Up Your Environment**: Follow the [Getting Started](README.md#getting-started) guide in the README to set up your development environment. 4. **Create a Branch**: Create a new branch for your changes: ```bash git checkout -b feature/your-feature-name ``` 5. **Make Your Changes**: Implement your changes, ensuring you follow the project's coding standards. 6. **Write Tests**: If applicable, add tests for your changes in the `tests/` directory. 7. **Run Tests**: Ensure all tests pass before submitting your changes: ```bash pytest ``` 8. **Commit Your Changes**: Commit your changes with a descriptive commit message: ```bash git add . git commit -m "Add feature: your feature description" ``` 9. **Push Your Changes**: Push your branch to your forked repository: ```bash git push origin feature/your-feature-name ``` 10. **Open a Pull Request**: Open a pull request from your branch to the `main` branch of the original repository. Provide a clear description of your changes and why they are necessary. ## Code of Conduct This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. ## Reporting Issues If you encounter any issues or have suggestions for improvements, please open an issue in the [GitHub Issues](https://github.com/christianlouis/QuizzicalBeats/issues) section. Provide as much detail as possible to help us understand and address the issue. ## Style Guide - Follow [PEP 8](https://pep8.org/) for Python code. - Use 4 spaces for indentation. - Write clear and concise commit messages. - Document your code where necessary, especially for complex logic. ## License By contributing to Quizzical Beats, you agree that your contributions will be licensed under the [MIT License](LICENSE). Thank you for contributing to Quizzical Beats!