Differences

This shows you the differences between two versions of the page.

--- docs:guide-developer:working-with-github-pr [2019/03/23 15:16] – created bobafetthotmail
+++ docs:guide-developer:working-with-github-pr [2023/03/18 23:29] (current) – [Reopen closed PR] he/she -> they ryanc
@@ Line 1: / Line 1: @@
-===== Working with Github =====
+====== Working with GitHub ======
+There are GitHub mirrors of the source repository [[https://github.com/openwrt/openwrt|here]].
-There are Github mirrors of the source repository [[https://github.com/openwrt/openwrt|here]].\\
+Fork the project to a public repo using GitHub web interface, clone the repo to your computer, create a branch for your changes, push these back to GitHub and submit a pull request.
-Fork the project to a public repo using Github web interface, clone the repo to your computer, create a branch for your changes, push these back to Github and submit a pull request.
-In case you don't know how to do that, keep reading.\\
+In case you don't know how to do that, keep reading.
-Create a Github account, this will host your public fork of LEDE source, and will be used for all interaction on Github.
+Create a GitHub account, this will host your public fork of OpenWrt source, and will be used for all interaction on GitHub.
-Install git in your PC, and make sure that your local git settings have the right name and email\\
+Install git in your PC, and make sure that your local git settings have the right name and email:
-<code>
+<code bash>
 git config --global user.name "my name"
 git config --global user.email "my@email.address"
 </code>
-You might also want to set the default text editor to your favourite editor.
+You might also want to set the default text editor to your favorite editor.
-If you have a Linux system with a GUI, some choices are **geany**, **kwrite**, **pluma** and **gedit**.\\
+If you have a Linux system with a GUI, some choices are **geany**, **kwrite**, **pluma** and **gedit**.
-If you are using command line, **nano** is a good one. <code>git config --global core.editor "editor-name-here"</code>
+If you are using command line, **nano** is a good one.
-Then follow Github's excellent documentation to [[https://help.github.com/articles/fork-a-repo/|Fork A Repo]] and [[https://help.github.com/articles/fork-a-repo/#step-2-create-a-local-clone-of-your-fork|Create a local clone of your fork]]\\
+<code bash>
+git config --global core.editor "editor-name-here"
+</code>
-After you have set it up as described, write <code>git checkout -b my-new-branch-name</code> to create a branch for your PR ("my-new-branch-name" is just an example name, use a more descriptive name in yours).\\
+Then follow GitHub's excellent documentation to [[https://help.github.com/articles/fork-a-repo/|Fork A Repo]] and [[https://help.github.com/articles/fork-a-repo/#step-2-create-a-local-clone-of-your-fork|Create a local clone of your fork]].
-All commits you do after this command will be grouped in this branch. This allows to have multiple branches, one for each PR.\\
-To switch between branches you already created, use <code>git checkout my-branch-name</code>
-After you made your changes, write <code>git add -i</code> and use its interface to add untracked (new) files and update existing ones.\\
+After you have set it up as described, write
-Then write <code>git commit --signoff</code> This will open the git default editor and you can write the commit message. \\
+<code bash>
-The first line is the commit subject, \\
+git checkout -b my-new-branch-name
-then leave an empty line \\
+</code>
-then you write the commit description. \\
-This command will automatically add the Signed-off-by line with your name and email as set above.\\
-For example, a complete commit message might look like this:\\
-  The best code update.
-  This is the best piece of code I have ever submitted.
-  Signed-off-by: John Doe <John.Doe@test.com>
-To send your local changes over to your Github repo, write <code>git push --all</code>
+to create a branch for your PR ("my-new-branch-name" is just an example name, use a more descriptive name in yours).
-You will be asked your github user and password in the process.\\
-After the code has been uploaded to your github repo, you can submit PR using Github web interface, see again Github's documentation about [[https://help.github.com/articles/creating-a-pull-request/|Creating a pull request]]\\
+All commits you do after this command will be grouped in this branch.
+This allows to have multiple branches, one for each PR.
+To switch between branches you already created, use
+<code bash>
+git checkout my-branch-name
+</code>
+After you made your changes, write
+<code bash>
+git add -i
+</code>
+and use its interface to add untracked (new) files and update existing ones.
+Then write
+<code bash>
+git commit --signoff
+</code>
+This will open the git default editor and you can write the commit message.
+The first line is the commit subject, then leave an empty line, then you write the commit description.
+This command will automatically add the Signed-off-by line with your name and email as set above.
+For example, a complete commit message might look like this:
+<code bash>
+The best code update.
+This is the best piece of code I have ever submitted.
+Signed-off-by: John Doe <John.Doe@test.com>
+</code>
+To send your local changes over to your GitHub repo, write
+<code bash>
+git push --all
+</code>
+You will be asked your GitHub user and password in the process.
+After the code has been uploaded to your GitHub repo, you can submit pull request using GitHub web interface, see again GitHub's documentation about [[https://help.github.com/articles/creating-a-pull-request/|Creating a pull request]].
+===== Squashing commits =====
+Commits in a PR or sent by email should be about full changes you want to merge, not about fixing all issues the reviewers found in your original PR.
+So, there will come a time when you will need to either rewrite or squash your commits; so you end with a normal amount of true and sane commits.
+Work with git commandline.
+Change to your development folder.
+Look at the branches you have with:
+<code bash>
+git branch -a
+</code>
+get something like:
+<code bash>
+  best_code_update
+* master
+</code>
+Switch to the your development branch for this PR with:
+<code bash>
+git checkout best_code_update
+</code>
+Look at the git log, so you can count the number of commits you want to squash ( the "X" below ) with:
+<code bash>
+git log
+</code>
+Delete commits with:
+<code bash>
+git reset HEAD~X
+</code>
+(where X is the number of commits you want to delete, counted from the last commit), this will not change modified files, it will only delete the commits.
+Add the files to git tracking again with:
+<code bash>
+git add -i
+</code>
+and commit again with:
+<code bash>
+git commit --signoff
+</code>
+Send the updated branch over to GitHub with:
+<code bash>
+git push -f
+</code>
+and the commits in the PR will be updated automatically.
+==== Alternative squashing advice ====
+You can use **interactive rebase** to combine, reorder and edit your commits and their commit messages, with:
+<code bash>
+git rebase -i HEAD~X
+</code>
+Where X is a number of commits to edit.
+===== Reopen closed PR =====
+GitHub will grey out "Reopen" and will not let you reopen a PR if you force-pushed anything to the relevant branch after the PR has been closed, or deleted the branch.
+However, reopening is still possible if you just set back the GitHub branch to the exact commit ID/hash it was at when you closed it. This even works when the branch or even the whole repository was deleted on GitHub. It just has to be recreated with the same name (for repo and branch) and the same commit hash at the branches HEAD.
+A possible way to do that would be (there might be others, even shorter ones):
+//We assume that the git remote referring to GitHub is called "origin", the branch of interest is called "testbranch", and the local and remote branch names are the same.//
+<code bash>
+# Get the hash yyyyyyyyyyyyyyy of the current state of "testbranch" (we will move the branch head later)
+git log -1 testbranch
+# Checkout the latest state of the PR (commit hash xxxxxxxxxxx)
+git checkout xxxxxxxxxx
+# Delete old testbranch
+git branch -D testbranch
+# Label current state as testbranch
+git checkout -b testbranch
+# Push old state to GitHub
+git push -f origin testbranch
+</code>
+Now you got GitHub at the state it was at when closing the PR. It should now be possible to "reopen" the PR.
+Note that this will only be possible if //you// closed it. If it was closed by an admin, you will have to ask an admin to reopen it (though they will also only be able to do that when the branch is at the proper hash).
+If the PR is reopened, you can update as usual, e.g.
+<code bash>
+# Checkout the desired hash yyyyyyyyy (or branch)
+git checkout yyyyyyyyy
+# Delete intermediate testbranch
+git branch -D testbranch
+# Label current state as testbranch
+git checkout -b testbranch
+# Push new state to GitHub
+git push -f origin testbranch
+</code>