Contribution and Development

Run the following command to obtain a local copy of this repository! This only needs to happen once!

git clone https://github.com/UCR-Solar-Car/DriverInterface.git

Check out the issues tab to see current thats that need to be worked on! Issues have various labels to help us organize their priority and workload. LIGHTWORK and HEAVYWORK estimate the research and workload required to complete the issue. LOW, MEDIUM, HIGH represent the priority levels. HIGH and MEDIUM are issues that need to be completed in order for the Solar Car to work efficiently. LOW represents small bugs/issues/inconviences that will usually not affect the overall performace or output of the application.

Once you have chosen an issue to work on, create a branch using the following naming convention github_username/feature_name (ie ucrsolarcar/add_icons). This will help organize who has worked on what code and ensure we are accountable for our code. Once you have pushed your code to Github, create a pull request and send it in the #updates channel in the Software Category. Ensure that you link the pull request with the corresponding issue so we know which issue your code solves. Ensure that you fix any merge conflicts, if they should arise. After you have gotten your reviews, you may merge your code and the branch will automatically delete. The issue should automatically close as well.