| You are not Logged In! |
Public:GitHub
|
This Page is a Work In Progress |
| Moving to subpages, getting rid of tabs, adding info for the other Repos. This page will turn into generally using github - Jonathan | |
|
Note |
| This page is about the set-up and workflow we use on Github. Other pages are used for how git is used with certain software such as KiCad or MCUXpresso. Additionally, it does not include info about github management, teams, and projects as used by Illini Solar Car, which is at GitHub Projects | |
Illini Solar Car has several git repositories within our organization on GitHub. You must talk with an Electrical Lead or Strategy & Telemetry Lead so they can give you access to our private repositories. In general, many people use git via the command line. We use it almost exclusively, and you should learn it in order to git (haha) on the same page as everyone else. On most Linux distros this is included in command line. On Mac and Windows you can download git. When "Adjusting your PATH environment," I recommend selecting "Use Git from Git Bash" and not using git in the Windows Command Prompt. When "Configuring the line ending conversions" please use the settings recommended for your operating system unless you know what you are doing.
If you're new to Github they're many resources on the internet to learn more about it. Watching some youtube videos on the basics and trying it out by creating your own repository is a great way to get started.
General Guidelines
- Make your commit messages useful
- Pull often!
- Commit often (but not too often)
- If you aren't sure what you are doing ask for help!
- If you think you broke something talk to someone right away!
- It essentially always fixable but we want to do so quickly so others don't run into problems
Info on how to use git by group:
FW (Firmware)
See repositories to clone: GitHub/b-fw
and GitHub/ARGO-FW
and info on submoduled repositories: GitHub/mbed
and GitHub/CAN
See GitHub/Telemetry
Tutorials
Git is a super useful tool that is becoming ubiquitous with CS / ECE and more engineering fields. It is used for all sorts of things (not just code) . Version control is incredibly powerful, but because of that it can be hard to learn. Below are some recommended tutorials. Of course, as git was made for code, there is tons of info on the internet. Being good with git will be very helpful within jobs and academics.
