Skip to content

Commit d0f373c

Browse files
committed
feat: add 'file status' and 'commit' docs inside git
1 parent 04ce9c3 commit d0f373c

File tree

4 files changed

+46
-0
lines changed

4 files changed

+46
-0
lines changed

docs/07-Features/04-git.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,49 @@ In the Clone Repository dialog, clicking on `More Options` expands additional se
4040

4141
*If cloning fails due to authentication issues (e.g., timeout errors), you might need to manually provide your credentials.*
4242

43+
44+
## File status
45+
46+
All files with changes are displayed in the Git panel along with their status, such as *Modified*, *Untracked*, and *Deleted*. For modified files, a Git diff button is available.
47+
48+
![Git diff Icon](./images/git-images/git-diff-icon.png "Git diff icon")
49+
50+
*Git diff is used to display the changes made to a file — green lines indicate added content, while red lines show removed content.*
51+
Clicking on the Git diff icon opens up the Git diff dialog page.
52+
53+
![Git diff Dialog](./images/git-images/git-diff-dialog.png "Git diff dialog")
54+
55+
### Discard changes
56+
57+
For *Modified* and *Deleted* file statuses, a `Discard Changes...` button is shown. Clicking it will reset the changes for *Modified* files and restore *Deleted* files.
58+
59+
For *Untracked* files, a `Delete File...` button is available. Clicking it will delete the file.
60+
61+
![Discard changes or Delete file](./images/git-images/discard-changes.png "Discard changes or Delete file")
62+
63+
64+
65+
## Commit
66+
67+
To stage/unstage the files, click the checkbox icon at the top-left of the Git panel. This will affect all the files in the working tree.
68+
69+
![Stage all files](./images/git-images/stage-files.png "Stage all files")
70+
71+
You can also stage/unstage individual files by selecting or deselecting the checkbox next to each file.
72+
73+
Once you get all your required files to the staging area, click on the `Commit` button.
74+
75+
![Commit the files](./images/git-images/git-commit.png "Commit the files")
76+
77+
This will open up Git commit dialog box, which will display all the changes made to the files that are to be commited.
78+
You can enter your commit message in the input box provided.
79+
80+
![Git Commit dialog](./images/git-images/commit-dialog.png "Git commit dialog box")
81+
82+
> The commit input box also displays the number of characters in the commit message.
83+
84+
*If your commit message is longer, you can use the `Extended` button at the top-right of the dialog. This expands the input area, making it easier to write detailed commit messages.*
85+
86+
The commit dialog box also provides options to :-
87+
* **Amend Last Commit**: Selecting this option allows you to modify the most recent commit instead of creating a new one.
88+
* **Skip Pre-Commit Checks**: Enabling this option bypasses any pre-commit hooks or validation steps.
101 KB
Loading
45.3 KB
Loading
54.4 KB
Loading

0 commit comments

Comments
 (0)