# Contributing Guidelines Thank you for considering contributing to this project! I appreciate your interest and support. To ensure a smooth and collaborative development process, please follow these guidelines when making contributions. ## Table of Contents - [Contributing Guidelines](#contributing-guidelines) - [Table of Contents](#table-of-contents) - [Getting Started](#getting-started) - [Code Style](#code-style) - [Submitting Changes](#submitting-changes) - [Reporting Issues](#reporting-issues) - [Community Guidelines](#community-guidelines) - [License](#license) - [Code Review Process](#code-review-process) ## Getting Started Before you start contributing, please make sure you have the following: - A GitHub account - Basic knowledge of Git and GitHub - A local development environment set up ## Code Style To maintain consistency and readability, we follow a specific code style. Please adhere to the following guidelines: - Add comments to explain complex code sections - Indent using tabs (not tabs) - Use meaningful variable and function names ## Submitting Changes To contribute to the project, follow these steps: 1. Fork the repository 2. Create a new branch for your changes 3. Make your changes and commit them 4. Push your changes to your forked repository 5. Open a pull request to the main repository ## Reporting Issues If you encounter any issues or bugs, please report them using the issue tracker on GitHub. When reporting an issue, provide as much detail as possible, including steps to reproduce the problem and any relevant error messages. ## Community Guidelines We strive to maintain a welcoming and inclusive community. Please adhere to the following guidelines when interacting with other contributors: - Be respectful and considerate of others' opinions - Avoid offensive or discriminatory language - Help others and provide constructive feedback - Follow the project's code of conduct ## License By contributing to this project, you agree that your contributions will be licensed under the [MIT License](https://opensource.org/licenses/MIT). We appreciate your contributions and look forward to your involvement in our project! ## Code guidelines (c++) - 4 spaces tab indentation - curly braces on a new line for functions and classes - write code for human beings, not for machines - have fun! ## Code Review Process To ensure the quality and maintainability of the codebase, we have a code review process in place. Follow these steps when submitting your changes for review: 1. Ensure that your code follows the project's code style guidelines mentioned above. 2. Create a pull request from your branch to the main repository. 3. Provide a clear and concise description of the changes you made and the problem they solve. 4. Assign the pull request to a reviewer or request a review from the project maintainers. 5. Address any feedback or comments