How to Push Changes

Using git and GitHub, there are several ways to push your changes to a repository. You can commit changes directly to the main (or master) branch, which is usually not preferred.

Instead, you will interact with this repository (and most other lunabotics repos) by creating a new branch that describes a feature or fix. You will then commit your changes on this branch. Once the feature or fix is complete, you will create what’s called a Pull Request.

What is a Pull Request?

A Pull Request is just a way for your branch to be merged to the main branch, pushing all your changes at once. This is preferred as it also allows for external review by other programmers to ensure quality, correctness, and tests, before changes are pushed to the main branch.

For more information about what a Pull Request is, look at the official GitHub documentation.

How to Create a Pull Request

To create a Pull Request, go to this repository on GitHub and follow the official GitHub documentation.

There is a VSCode extension named GitHub Pull Requests author GitHub that allows you to create/review PR’s in the IDE. This is the recommended way to review PR’s as it lets more easily see code changes and use the markdown preview functionality and website preview abilities.

Once the Pull Request is submitted, it will be reviewed by other programmers. They will accept it or give suggestions or improvements to make the code and result better.

After your Pull Request is accepted, your changes will be merged to the main branch. If you plan to keep making edits, feel free to keep this branch up and active, and submit a new Pull Request if needed. Otherwise, if the feature or fix is complete, you may delete the branch on GitHub.

Conclusion

Congratulations! You have successfully edited the documentation and pushed your changes using Pull Requests! If you have any questions, comments, or concerns, feel free to hesitate to any programming (or non-programming!) member for assistance. We are always here to help you learn and grow wherever we can! Have fun documenting!

Author: Aiden Kimmerling https://github.com/TheKing349