Skip to content

Latest commit

 

History

History
82 lines (56 loc) · 5.55 KB

README.md

File metadata and controls

82 lines (56 loc) · 5.55 KB
Raw

Software Onboarding 2024 | Day 1

Welcome to Day 1 of the Sooner Competitive Robotics software onboarding! Today we are going to focus a few smaller tasks to get you warmed up and familiar with the tools we use. By the end of today, you should have a very basic understanding of Git and Python! It is important to note that if you have never programmed before you will have to do some additional learning on your own time. We will provide resources to help you along the way, but it is up to you to put in the effort to learn and grow as a software member.

Table of Contents

  1. Git
  2. Python
  3. Pong
  4. Snake
  5. Additional Resources

Git

Git is a version control system that we use to manage our codebase. It allows us to track changes to our code and collaborate with other team members effectively. If you have not already installed Git, please refer back to the Getting Started section for instructions on how to do so.

To cover the basics of Git, we will be working through the Learn Git Branching tutorial. If you are reading this on your own, please take some time to work through the tutorial and familiarize yourself with the basic commands and concepts of Git. If you are reading this with the team, we will work through the tutorial together and answer any questions you may have. We will mainly be focusing on levels 1 and 2 (Introduction to Git Commits and Branching in Git) today.

There are four commands it does not cover that are important to know:

  • git status - This command shows the status of the working directory and the staging area. It lets you see which changes have been staged, which haven't, and which files aren't being tracked by Git.
  • git fetch - This command downloads commits, files, and refs from a remote repository into your local repo. It will not merge the changes into your local branch.
  • git pull - This command fetches changes from a remote repository and merges them into your local branch.
  • git push - This command sends the committed changes to the remote repository.

Pull Requests and Github

So, if git does all of this magic on my computer why do I need to know about Github? Well, Github allows us to host our codebase on the internet so other developers can access it. It also provides us a way to visually review changes and collaborate on code. At the end of onboarding, we will be using its pull request feature which allows you to pull your changes into a different branch. Typically, we prevent developers from pushing into the "main" branch and instead require pull requests. This allows us to review the changes and ensure that the main branch always remains stable.

Cloning the Repository

If you haven't already, create a Github account and send me your username so I can add you to the organization. Next, clone the repository by running the following command in your terminal:

git clone https://github.com/SoonerRobotics/onboarding_software_2024

If you have any issues with this step, please reach out to me or any of the other team members for help.

Creating a Branch

Create a new branch by running the following command in your terminal:

git checkout -b <branch-name>

For the purposes of onboarding, your branch name should be onboarding/<your-name>. In practice, we have various branch naming standards we try to follow on all of our repositories (but is not always the case).

Installing Dependencies

Run the following command in the root directory of this project to install the dependencies:

pip install -r requirements.txt

Tasks

Pong

Okay, so you may be wondering "Well Dylan, isn't Pong a bit of a stretch to start with?" and to that I say yes it definitely is. We will not be implementing any of the programs over the next few days from scratch, but rather we will be fixing various issues and learning how to work with an existing codebase. This will give you a good idea of what it is like to navigate through someone else's code and provide some additional problem solving skills. We try to keep our codebases well documented and easy to read, but as the lead software developer for the last two years I can assure you that is not always the case. Below is a list of "features" or bugs that need to be implemented/fixed within pong, most of the tasks these will be basic and require minimal programming knowledge. Make sure every time you fix or implement one of these features you make a new commit with a somewhat descriptive message!

  • The ball is way too small, make it bigger.
  • The ball is way too slow, make it faster.
  • For some reason the ball is hitting my side and giving me a point.
  • Change the left paddle to be a sky blue (#87CEEB).
  • Change the right paddle to be magenta (#4C004C).
  • The score is incrementing by 1 instead of 2.
  • The year is correct, make it wrong.

Snake

Alright, so we are gonna do what we did before but with snake. Same idea, fix/implement the points below and make a new commit for each one.

  • Comic Sans is a terrible font, change it to something else.
  • The score is decrementing instead of incrementing.
  • The fruit is blue, why is the fruit blue? Change it to red.
  • If the snake is moving right and I press left it should not let me.
  • Add the ability to play with the arrow keys.

And if you want a slightly more challenging task:

  • Add the ability to (un)pause the game by pressing the space bar.
  • Add the ability to restart the game by pressing the 'r' key.
  • Let the snake wrap around the screen instead of dying when it hits the wall.