| title | intro | redirect_from | versions | shortTitle | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
Committing and reviewing changes to your project in GitHub Desktop |
{% data variables.product.prodname_desktop %} tracks all changes to all files as you edit them. You can decide how to group the changes to create meaningful commits. |
|
|
Commit & review changes |
{% data reusables.commits.about-commits %} You can also add a co-author on any commits you collaborate on.
{% data reusables.desktop.update-email-address %} For more information, see AUTOTITLE.
{% ifversion repo-rules %}
Repository administrators can enable rulesets for a branch to enforce specific conventions when committing. For example, a ruleset can require a commit to be signed, or for an issue number to be referenced at the start of a commit message. {% data variables.product.prodname_desktop %} will display a warning and prevent committing if a commit does not follow the rulesets. For more information, see AUTOTITLE.
{% endif %}
-
Create a new branch, or select an existing branch by clicking {% octicon "git-branch" aria-hidden="true" %} Current Branch on the toolbar and selecting the branch from the list.
{% data reusables.desktop.make-changes %}
You can change the way diffs are displayed in {% data variables.product.prodname_desktop %} to suit your reviewing needs.
To change how you view diffs, in the top-right corner of the diff view, click {% octicon "gear" aria-label="The Gear icon" %}.
- To change how the entire diff is displayed, under "Diff display", select Unified or Split. The Unified view shows changes linearly, while the Split view shows old content on the left side and new content on the right side.
- To hide whitespace changes so you can focus on more substantive changes, select Hide Whitespace Changes.
{% data reusables.desktop.diff-tab-size-tip %}
If you need to see more of the file than {% data variables.product.prodname_desktop %} shows by default, you can expand the diff.
- To see the next few lines above or below the highlighted changes, click the arrow above or below the line numbers.
- To see the entire file, right-click in the diff view and click Expand Whole File.
As you make changes to files in your text editor and save them locally, you will also see the changes in {% data variables.product.prodname_desktop %}.
In the "Changes" tab in the left sidebar:
-
The red {% octicon "diff-removed" aria-label="The diff removed icon color-red" %} icon indicates removed files.
-
The yellow {% octicon "diff-modified" aria-label="The diff modified icon color-yellow" %} icon indicates modified files.
-
The green {% octicon "diff-added" aria-label="The diff added icon color-green" %} icon indicates added files.
-
To access stashed changes, click Stashed Changes.
-
{% data reusables.desktop.commit-all-desc %}
-
{% data reusables.desktop.commit-some-desc %}
If one file contains multiple changes, but you only want some of those changes to be included in a commit, you can create a partial commit. The rest of your changes will remain intact, so that you can make additional modifications and commits. This allows you to make separate, meaningful commits, such as keeping line break changes in a commit separate from code or prose changes.
To exclude changed lines from your commit, click one or more changed lines so the blue disappears. The lines that are still highlighted in blue will be included in the commit.
If you have uncommitted changes that you don't want to keep, you can discard the changes. This will remove the changes from the files on your computer. You can discard all uncommitted changes in one or more files, or you can discard specific lines you added.
Discarded changes are saved in a dated file in the Trash. You can recover discarded changes until the Trash is emptied.
{% data reusables.desktop.select-discard-files %} {% data reusables.desktop.click-discard-files %}
{% data reusables.desktop.confirm-discard-files %}
You can discard one or more changed lines that are uncommitted.
Note
Discarding single lines is disabled in a group of changes that adds and removes lines.
To discard one added line, in the list of changed lines, right-click the line number of the line you want to discard, then select Discard Added Line.
To discard a group of changed lines, right-click the vertical bar to the right of the line numbers for the lines you want to discard, then select Discard added lines.
Once you're satisfied with the changes you've chosen to include in your commit, write your commit message and push your changes. If you've collaborated on a commit, you can also attribute a commit to more than one author.
Note
{% data reusables.desktop.tags-push-with-commits %} For more information, see AUTOTITLE.
{% data reusables.desktop.commit-message %}
-
Optionally, to attribute a commit to another author, click the add co-authors icon and type the username(s) you want to include.
{% data reusables.desktop.commit-button %} -
If the branch you're trying to commit to is protected, Desktop will warn you.
- To move your changes, click switch branches.
- To commit your changes to the protected branch, click Commit to BRANCH.
For more information about protected branches, see AUTOTITLE. {% data reusables.desktop.push-origin %}
-
If you have a pull request based off the branch you are working on, {% data variables.product.prodname_desktop %} will display the status of the checks that have run for the pull request next to the "Current Branch" section of the repository bar. For more information about checks, see AUTOTITLE.
If a pull request has not been created for the current branch, {% data variables.product.prodname_desktop %} will give you the option to preview the changes and create one. For more information, see AUTOTITLE.
If you need to undo a commit or revise your commit history (to make it easier for a reviewer to follow your changes), {% data variables.product.prodname_desktop %} provides a number of options for managing your commit history. For more information, see AUTOTITLE.