Github Workflow#
- Fork The Project
- Adding the Forked Remote
- Create & Rebase Your Feature Branch
- Commit & Push
- Open a Pull Request
This guide assumes you have already cloned the upstream repo to your system via git clone, or via go get github.com/k0sproject/k0s.
Fork The Project#
- Go to http://github.com/k0sproject/k0s
- On the top, right-hand side, click on "fork" and select your username for the fork destination.
Adding the Forked Remote#
export GITHUB_USER={ your github's username }
cd $WORKDIR/k0s
git remote add $GITHUB_USER git@github.com:${GITHUB_USER}/k0s.git
# Prevent push to Upstream
git remote set-url --push origin no_push
# Set your fork remote as a default push target
git push --set-upstream $GITHUB_USER main
Your remotes should look something like this:
➜ git remote -v
origin https://github.com/k0sproject/k0s (fetch)
origin no_push (push)
my_fork git@github.com:{ github_username }/k0s.git (fetch)
my_fork git@github.com:{ github_username }/k0s.git (push)
Create & Rebase Your Feature Branch#
Create a feature branch:
git branch -b my_feature_branch
git fetch origin
git rebase origin/main
Current branch my_feature_branch is up to date.
git pull instead of the above fetch / rebase. git pull does a merge, which leaves merge commits. These make the commit history messy and violate the principle that commits ought to be individually understandable and useful.
Commit & Push#
Commit and sign your changes:
git commit -m "my commit title" --signoff
commit --amend in a few cycles.
When ready, push your changes to your fork's repository:
git push --set-upstream my_fork my_feature_branch
Open a Pull Request#
Get a code review#
Once your pull request has been opened it will be assigned to one or more reviewers, and will go through a series of smoke tests.
Commit changes made in response to review comments should be added to the same branch on your fork.
Very small PRs are easy to review. Very large PRs are very difficult to review.
Squashing Commits#
Commits on your branch should represent meaningful milestones or units of work. Small commits that contain typo fixes, rebases, review feedbacks, etc should be squashed.
To do that, it's best to perform an interactive rebase:
Example#
If you PR has 3 commits, count backwards from your last commit using HEAD~3:
git rebase -i HEAD~3
pick f7f3f6d Changed some code
pick 310154e fixed some typos
pick a5f4a0d made some review changes
# Rebase 710f0f8..a5f4a0d onto 710f0f8
#
# Commands:
# p, pick <commit> = use commit
# r, reword <commit> = use commit, but edit the commit message
# e, edit <commit> = use commit, but stop for amending
# s, squash <commit> = use commit, but meld into previous commit
# f, fixup <commit> = like "squash", but discard this commit's log message
# x, exec <command> = run command (the rest of the line) using shell
# b, break = stop here (continue rebase later with 'git rebase --continue')
# d, drop <commit> = remove commit
# l, label <label> = label current HEAD with a name
# t, reset <label> = reset HEAD to a label
# m, merge [-C <commit> | -c <commit>] <label> [# <oneline>]
# . create a merge commit using the original merge commit's
# . message (or the oneline, if no original merge commit was
# . specified). Use -c <commit> to reword the commit message.
#
# These lines can be re-ordered; they are executed from top to bottom.
#
# However, if you remove everything, the rebase will be aborted.
#
# Note that empty commits are commented out
pick to fixup for the commits you want to squash, then save your changes and continue the rebase:
Per the output above, you can see that:
fixup <commit> = like "squash", but discard this commit's log message
Push Your Final Changes#
Once done, you can push the final commits to your branch:
git push --force
rebase/push -f, if needed.