Creating a pull request¶
You can contribute to this project by opening a pull request that will be reviewed by maintainers and integrated into the main repository when the changes made are approved. You can contribute bug fixes, changes to the documentation, or new functionality you have developed.
You can follow these steps to create a pull request for this project:
-
Fork the repository, clone it and create a new branch:
-
Add your changes to the codebase.
-
Commit your changes with your sign-off message:
Tip
A sign-off message in the following format is required on each commit in the pull request:
This will use your default git configuration which is found in
.git/config
and usually, it is theusername systemaddress
of the machine which you are using.To change this, you can use the following commands (Note these only change the current repo settings, you will need to add
--global
for these commands to change the installation default).Your name:
Your email:
-
Push your commit to your forked repository:
-
Create a pull request. See GitHub's official documentation for more details.