This repository is used to practice contributing to the Robotics Club projects through GitHub and Git.
Currently, we use the Forking Workflow for git. For a quick summary of this workflow, there is a main hosted repository for the code (GitHub). Anyone who wants to contribute will create a fork of this repository (make a copy to their own GitHub account). Make their desired changes in their own repository, and then submit those changes back to the main repo through a pull request. For a more in-depth explanation, check out this tutorial from Atlassian: Atlassian Explanation. If you have any questions, feel free to ask in the Programming Team Discord channel.
How To Contribute
- Fork this repo (make a copy to your GitHub account by using the "Fork" button)
- Clone your repository to your machine
git clone [URL/TO/YOUR/REPO] - Make the changes on your machine
- Commit and push your code back to your GitHub repo
git add [FILES/CHANGED]git commit -m "COMMIT MESSAGE HERE"git push - Make a pull request against the main repo (done through GitHub)
- The pull request will be reviewed, and if it meets criteria and is helpful, it will be merged into the main repo.
- Congradulations!!!
For this project, please follow the steps above and add your username to the list below. Your commit message should be something descriptive IE "Added [USERNAME] to README.md".
Add your username to the list!
- DATE: USERNAME - Preffered first name [OPTIONAL]
- 2024-09-13: KittKat7 - Avery
- 2024-09-13: ORSS01
- 2024-09-13: Cryrosphere - Caden
- 2024-09-13: lovdw