Thank you for considering contributing to our project! We appreciate your time and effort in helping us improve. Please follow these guidelines to ensure a smooth contribution process.
-
Fork/Clone the Repository: Start by forking and cloning the repository to your GitHub account.
-
Create a Branch: Create a new branch for your feature or bug fix.
- For features:
git checkout -b feat/feature-name - For issues:
git checkout -b issue/issue-name
-
Make Changes: Make your changes in the new branch. Ensure that your code follows the repository’s code formatting guidelines.
-
Commit Changes: Commit your changes with a clear and descriptive commit message. git commit -m "Add feature: description of your feature"
-
Push to GitHub: Push your changes 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 repository’s main branch. Provide a detailed description of your changes and any related issues.
To maintain consistency across the codebase, please ensure that your code follows the repository’s code formatting. This will make the review and merge process much more efficient.
If you find any bugs or have feature requests, please open an issue in the repository. Provide as much detail as possible to help us understand and address the issue.
Thank you for contributing! :)