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

Fork the Repository: Start by forking the repository to your GitHub account.

Clone Your Fork: Clone your forked repository to your local machine:

git clone https://github.com/christianlouis/QuizzicalBeats.git
cd QuizzicalBeats

Set Up Your Environment: Follow the Getting Started guide in the README to set up your development environment.
Create a Branch: Create a new branch for your changes:
```
git checkout -b feature/your-feature-name
```
Make Your Changes: Implement your changes, ensuring you follow the project's coding standards.
Write Tests: If applicable, add tests for your changes in the tests/ directory.
Run Tests: Ensure all tests pass before submitting your changes:
```
pytest
```
Commit Your Changes: Commit your changes with a descriptive commit message:
```
git add .
git commit -m "Add feature: your feature description"
```
Push Your Changes: Push your branch to your forked repository:
```
git push origin feature/your-feature-name
```
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. 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 section. Provide as much detail as possible to help us understand and address the issue.

Style Guide

Follow PEP 8 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.

Thank you for contributing to Quizzical Beats!

2.3 KiB Raw Blame History