Thank you for considering contributing to tFrogger! We welcome contributions from the community to help improve the project. Here are some guidelines to get you started.
If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please include:
- A clear and descriptive title.
- A detailed description of the problem or suggestion.
- Steps to reproduce the issue, if applicable.
- Any relevant screenshots or error messages.
We welcome pull requests for bug fixes, new features, and improvements. To submit a pull request:
-
Fork the Repository: Create a personal fork of the repository on GitHub.
-
Clone the Fork: Clone your fork to your local machine.
git clone https://github.com/gfargo/tfrogger.git
-
Create a Branch: Create a new branch for your changes.
git checkout -b feature/your-feature-name
-
Make Changes: Implement your changes, following the coding standards outlined below.
-
Test Your Changes: Ensure that your changes do not break existing functionality.
-
Commit and Push: Commit your changes and push them to your fork.
git commit -m "Add your commit message here" git push origin feature/your-feature-name -
Open a Pull Request: Go to the original repository and open a pull request from your branch.
- Code Style: Follow the existing code style and conventions used in the project.
- Comments: Write clear and concise comments to explain complex logic.
- Testing: Ensure that your changes are covered by tests, if applicable.
Please note that this project is governed by a Code of Conduct. By participating, you are expected to uphold this code.
By contributing to tFrogger, you agree that your contributions will be licensed under the MIT License.
Thank you for your contributions! We look forward to working with you. 😊