Thank you for considering contributing code to our project! Below are the steps to submit your code contribution.
Prerequisites
- GitHub Account - You must have a GitHub account to submit pull requests.
- Fork the Repository - Fork the main repository to your GitHub account.
- Clone the Forked Repository - Clone the forked repository to your local machine.
Contributing Process
Create a New Branch: From your local repository, create a new branch for your contribution.
git checkout -b feature/<branch-name>
Implement Your Changes: Make the necessary changes in the new branch. Ensure that your changes adhere to the coding standards and conventions of the project.
Commit Your Changes: Commit your changes with a clear and concise commit message.
git add <file-name> git commit -m "Add feature <feature-name>"
Push Your Branch: Push your branch to your forked repository on GitHub.
git push origin feature/<branch-name>
Create a Pull Request: Go to your forked repository on GitHub, and create a pull request from your new branch to the main repository's
master
branch.Review Your Pull Request: The maintainers will review your pull request. They may ask for changes or merge your contribution.
Merge: Once your pull request is approved, the maintainers will merge your code into the main repository.
Tips
- Code of Conduct: Please ensure that your contribution adheres to our Code of Conduct.
- Documentation: If your contribution affects the documentation, please update the relevant files.
- Testing: Include tests for your contribution to ensure that it works as expected.
By following these steps, you can contribute your code to our project and help make it better!
For more information on contributing, please visit our Contributing Guide.