4.1. Development Process Cheatsheet - tjmisko/sspi-data-webapp GitHub Wiki

< Back to Backend Guide

You can execute this process every time you sit down to work on the SSPI. It's only a few lines of code, and you can copy it from here.

Starting Work on a New Issue

gh issue develop -c [Issue Number] # create and checkout the branch for the issue
gh pr create -d -r tjmisko # create a draft pr with tjmisko as reviewer

Continuing Work

Just make sure you're on the branch that you set up in the steps above. By default, the branch created by gh issue develop -c [Issue Number] begins with the issue number, which can help you find it. Run

git switch [branch-name]

to get onto the right branch.

Doing Your Work

Ideally, your commits will do some specific job. For example, if you need to write three functions to finish your compute route, you might have three commits, one for each of the functions.

git add -p # select the particular lines of code you'd like to commit
git commit -m "feat: Implemented [what you did]" # or for very small changes, -m "fix: [what you did]"
git push # sync your local work with the upstream tracking branch

Submitting Finished Work

git push # If you haven't already
gh pr ready
⚠️ **GitHub.com Fallback** ⚠️