Skip to content

Commit ff32ffe

Browse files
committed
chore: fix typo in contribution guidelines.
1 parent cbcdc5b commit ff32ffe

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ We encourage use of [Conventional Commits](https://www.conventionalcommits.org/e
1414

1515
Generally speaking, just try to match the conventions you see in the code you are reading. For this project, these include:
1616

17-
* Do not use shortened command and function names. For example, use `set` instead of `s` instead of `set` and `$piece` instead of `$p`
17+
* Do not use shortened command and function names. For example, use `set` instead of `s` and `$piece` instead of `$p`
1818
* One command per line
1919
* Do not use dot syntax
2020
* Indentation with tabs

docs/menu-items.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# git-source-control Menu Items
22

3-
43
## Status
54
This menu option is analogous to the [git status](https://git-scm.com/docs/git-status) command and prints the status of the repository to the output.
5+
66
## Settings
77
This option opens the GUI's settings page project specific git-source-control settings can be configured. This includes the settings that were configured when running:
88
```
@@ -12,31 +12,43 @@ d ##class(SourceControl.Git.API).Configure()
1212
This page also includes the mappings configurations.
1313

1414
Any changes made to the settings must be saved using the 'Save' button in order to take effect.
15+
1516
## Launch Git UI
1617
This menu option opens the git-source-control GUI. From here commit messages can be written, files can be staged and committed, branches can be viewed.
18+
1719
## Add
1820
This menu option is analogous to the [git add](https://git-scm.com/docs/git-add) command. It will perform 'git add' on the currently open file, adding it to the files that can be staged.
21+
1922
## Remove
2023
This menu option will only appear if the currently open file has been already added using the 'Add' menu option. It undoes the effect of adding the file, similar to running [git reset](https://git-scm.com/docs/git-reset) on a specific file.
24+
2125
## Push to remote branch
2226
This option pushes the commits in the branch to the remote repository. This exhibits the same behavior as the [git push](https://git-scm.com/docs/git-push) command.
27+
2328
## Push to remote branch (force)
2429
This option forcibly pushes the commits in the branch to the remote repository. This is potentially destructive and may overwrite the commit history of the remote branch. This exhibits the same behavior as the [git push --force](https://git-scm.com/docs/git-push) command.
30+
2531
## Fetch from remote
2632
Much like the [git fetch](https://git-scm.com/docs/git-fetch) command, this option fetches the most recent versions of the branch without merging that version into the local copy of the branch.
2733
## Pull changes from remote branch
2834
Much like the [git pull](https://git-scm.com/docs/git-pull) command, this menu option pulls the most recent version of the current branch from a remote source, merging the changes into the local copy.
35+
2936
## Sync
3037
This option will synchronize a local repo with the remote repo. The sync operation is only enabled in basic mode. It encapsulates the pattern of fetching, pulling, committing and then pushing into one menu action. If there is no defined remote repository, it will simply commit any uncommitted files.
38+
3139
## Create new branch
3240
This menu option creates a new branch in the repository for changes to be committed to. It also changes the current branch to be the created branch. This mimics the behavior of the [git checkout -b](https://git-scm.com/docs/git-checkout) command.
41+
3342
## Check out an existing branch
3443
This option changes the currently checkout branch to a chosen branch. This mimics the behavior of the [git checkout](https://git-scm.com/docs/git-checkout) command.
3544
## Export all
3645
This option exports class files to the local file tree at the configured location.
46+
3747
## Export all (force)
3848
This option exports all class files regardless of whether they're already up to date in the local file tree or not.
49+
3950
## Import all
4051
This option imports the versions of the files that are found in the configured directory into the project. Files that are out of date or the same as the files in the project won't be imported.
52+
4153
## Import all (force)
42-
This menu option behaves similarly to the regular import but forces the files to be imported regardless of whether the on-disk version is the same or older.
54+
This menu option behaves similarly to the regular import but forces the files to be imported regardless of whether the on-disk version is the same or older.

0 commit comments

Comments
 (0)