Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 1.72 KB

github-flow.md

File metadata and controls

40 lines (31 loc) · 1.72 KB
Raw

Github flow

We have agreed, that we will work using Github flow. Simple instructions can be found below.

In short words, we are forking repository from Code for Poznan organisation to our repository, push the changes there and create pull requests from our branches (eg. w1stler:sample_branch) to codeforpoznan:master.

Link for reference: https://guides.github.com/introduction/flow/

How to setup your local repository?

  1. Fork repository from Code for Poznań
  2. Clone your (forked) repository to local computer
  3. Go to (cd project_name command) directory of cloned repository in a terminal
  4. Add upstream remote by executing command git remote add upstream https://github.com/CodeForPoznan/project_name.git

How to be up-to-date with upstream repository?

  1. git status
  • To make sure you are on master branch. If not: git checkout master to switch your current branch to master
  1. git fetch upstream
  • To fetch upstream repository (newest changes from master branch from upstream repository - in that case Code for Poznan's main branch for particular project)
  1. git merge upstream/master
  • To merge all the changes from upstream repository to your master branch.
  1. git push
  • to push all of the changes to forked repository

How to propose change in upstream repository?

  1. create your own branch
  • git checkout -b name_of_your_branch
  1. make changes in the code
  2. add the changes
  • git add name_of_the_file
  1. commit the files
  • git commit -m "message that explains the commit"
  1. push the changes to your own repository
  • git push origin name_of_your_branch
  1. go to Github website and create Pull Request from head eg.: w1stler:sample_branch to base codeforpoznan:master