Skip to content
This repository was archived by the owner on Sep 16, 2023. It is now read-only.

Latest commit

 

History

History
53 lines (36 loc) · 2.06 KB

software-guide.md

File metadata and controls

53 lines (36 loc) · 2.06 KB

Software Guide

Getting Started

Since all the group members ( except me 😂) are using MacBook. These steps can help you set up a workstation.

  1. Install Homebrew.
  2. Install iTerm2 (recommended).
  3. Install Fish and Oh My Fish (recommended). brew install fish
  4. Install python3. brew install python3
  5. Install pip (should be installed with python3 if you used Homebrew, use pip3 --version to check).
  6. Install Git brew install git
  7. Install Git LFS brew install git-lfs
  8. Create ssh key and upload public key to github

Coding Style

We are using Python and we can follow the coding style of Google.

Git(Hub)

If you have time, you can read the Pro Git book. But I know we all have many other works to do. So I just write some topics about Git that we will encounter in the our project.

Key points

  1. Create a new branch from master branch when you are working. (DO NOT commit to master branch directly)
  2. Don't have multiple long-term maintained branches.
  3. Don't commit to other teammates' branches.
  4. After your work is finished, created a PR (pull request) to master and add a reviewer to review your code.
  5. Use git lfs to track large files and certain binary files.

GitHub workflow

This is a team project, we want to have a simple and clean history of our work. We need to understand the GitHub flow.

Basic usage of git

https://rogerdudler.github.io/git-guide/

The most simple way is to remember whenever you make changes to you work, you use the commands

git add .
git commit -m "<your comment for you commit>"
git push origin <your branch>

Replace the contents in < > based on your situation.