Thank you for your interest in contributing to our project! Pull requests (PRs) are essential for improving and maintaining the quality of our codebase. To ensure a smooth and efficient contribution process, please follow the guidelines outlined below:
-
Fork the Repository: If you haven't already, fork the repository to your own GitHub account.
-
Clone the Repository: Clone the forked repository to your local machine using the following command:
git clone https://github.com/username/repository-name.git
-
Install Dependencies: Install any necessary dependencies required for the project.
-
Create a Branch: Create a new branch for your changes:
git checkout -b feature/your-feature-name
read: git brancing strategy
-
Make Changes: Make your desired changes to the codebase / documentation.
-
Sources: Make sure your update has a reference of base on experience.
-
Keep Commits Atomic: Commit your changes in logical, clear and descriptive.
-
Make Pull Request