Skip to content

How to Github

Emely edited this page Aug 19, 2021 · 12 revisions

git workflow

  1. checkout to dev and pull latest changes

  2. create feature branch from dev branch

  3. write code, commit frequently, push changes to remote

  4. create pull request

  5. review pull request, request changes if necessar and implement requested changes

  6. merge to dev

  7. delete branch

ressources

If your knew to git here are some good ressources to get to know the basics:

Git basics: https://www.freecodecamp.org/news/learn-the-basics-of-git-in-under-10-minutes-da548267cc91/

Git basics: https://www.youtube.com/watch?v=IHaTbJPdB-s](https://www.youtube.com/watch?v=IHaTbJPdB-s

Git workflow explained: https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow

pull request checklist

  • code formatted?
  • unnecessary comments removed?
  • printout statements removed?
  • If you made backend changes: Did all tests have passed? Do you need to adjust some tests or write knew ones?
  • If you made frontend changes: Did you test the UI on different devices/ browser (firefox, chrom, iphone, android phone)?
  • Is your code easy to understand or do you need to insert some comments?
  • explain the issue for the reviewer and your steps to solve the issue => makes it a lot more easy for the reviewer
  • label your pull request (frontend/ backend/ testing/ styling/ sql/...)

pull request review

pull request review practice

  • Bevor starting a knew ticket everybode has to look at the current opened pull requests and decide with the help of the labels what you can do (If later you feel like this is to complicated for you that's no problem you can always add a reviewer later)
  • pick out a pull request and assign your self so that no two people work on the same ticket
  • pull remote branch and test it
  • review line by line and add comments in github if necessary
  • If you have problems of understanding ask for a code walkthrough with the author of the pull request, if you are still unsure you can ask a second reviewer, ask for help on dicord
  • If you have questions/ problems that you want to assign for everybody ask on discord, if you have small questions that the author can answer ask directly on github to keep the conversation at one place

pull request review checklist

  • do all tests work
  • do we need additional tests
  • Is there double code
  • all unnecessary comments removed for example left printouts
  • do the names make sense/ are intuitive, easy to understand
  • Are the naming conventions appropriate?
  • Are there enough comments inline with the code?
  • can anything be simplified
  • test ui ⇒ different devices ⇒ any bugs
  • test also different browsers, sizes for ui bugs
Clone this wiki locally