Skip to content

Latest commit

 

History

History
62 lines (49 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

62 lines (49 loc) · 2.5 KB

Contributing to Tetris ESP32 Project

Thank you for considering contributing to the Tetris ESP32 project! We welcome all contributions, big or small. By contributing, you help improve and grow this project, making it better for everyone. Here's how you can get involved:

How to Contribute

1. Fork the Repository

Start by forking the repository to your GitHub account:

  1. Click the "Fork" button at the top of this repository.
  2. Clone the forked repository to your local machine: 
    git clone https://github.com/your-username/t-display-s3-tetris.git

2. Create a Branch

Create a branch for your changes to keep your work organized:

git checkout -b feature/your-feature-name

Use descriptive branch names, e.g., bugfix/game-crash, feature/new-game-level, etc.

3. Make Your Changes

  • Ensure that your code is clean and follows consistent styling with the rest of the project.
  • Test thoroughly to confirm that your changes don't introduce new issues.
  • Add documentation/comments if you introduce new features or modify existing functionality.

4. Commit Your Changes

Write clear, concise, and meaningful commit messages:

git add .
git commit -m "Add new feature to enhance gameplay speed"

5. Push Your Changes

Push your branch to your forked repository:

git push origin feature/your-feature-name

6. Create a Pull Request

Create a pull request (PR) from your forked repository branch to the main branch of this repository:

  1. Go to your forked repository on GitHub.
  2. Click the "New Pull Request" button.
  3. Ensure that your changes are described clearly in the pull request description. Reference any relevant issues if applicable.

Code of Conduct

Please follow our Code of Conduct to ensure a respectful and inclusive environment for everyone in our community.

Reporting Issues

Found a bug? Want to suggest an improvement? Please open an issue:

  1. Go to the Issues tab.
  2. Click "New Issue."
  3. Provide a detailed description, steps to reproduce (if applicable), and any other helpful information.

Community Support

  • Check out Discussions to connect with the community.
  • Ask questions, share insights, and collaborate with others.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

Thank you for helping make the Tetris ESP32 project better!