Skip to content

Commit 93c68ad

Browse files
committed
chore: grammar changes
1 parent b62b0d9 commit 93c68ad

File tree

28 files changed

+80
-174
lines changed

28 files changed

+80
-174
lines changed

.editorconfig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ insert_final_newline = true
1212
indent_style = space
1313
indent_size = 4
1414

15-
[{Makefile, **.mk}]
15+
[{Makefile,**.mk}]
1616
# Use tabs for indentation (Makefiles require tabs)
1717
indent_style = tab
1818

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ A clear and concise description of what the bug is.
1616
Steps to reproduce the behavior:
1717

1818
1. Go to '...'
19-
2. Click on '....'
20-
3. Scroll down to '....'
19+
2. Click on '...'
20+
3. Scroll down to '...'
2121
4. See error
2222

23-
If this is relating to a lint, then add the text of a commit that is triggering the lint.
23+
If this is related to a lint, then add the text of a commit that is triggering the lint.
2424

2525
**Expected behavior**
2626

CONVENTIONS.md

Lines changed: 0 additions & 92 deletions
This file was deleted.

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,7 @@ Each binary also has a command to generate completion.
282282
- [Using the issue number inserting part of the tool](./docs/mit-relates-to.md)
283283
- [Configuring lints](./docs/lints/configuring.md)
284284
- [Lint list](./docs/lints/index.md)
285+
- [Troubleshooting](./docs/troubleshooting.md)
285286

286287
### Usage
287288

docs/binaries/git-mit-config.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Commands:
3636
generate Generate the config file for your current settings
3737
available List the available lints
3838
enabled List the enabled lints
39-
status Get status of a lint
39+
status Get the status of a lint
4040
enable Enable a lint
4141
disable Disable a lint
4242
help Print this message or the help of the given subcommand(s)
@@ -56,8 +56,8 @@ Usage: git-mit-config mit <COMMAND>
5656
5757
Commands:
5858
set Update or add an initial in the mit configuration
59-
non-clean-behaviour Get the current behaviour when the repository is mid-rebase or merge
60-
set-non-clean-behaviour Set the current behaviour when the repository is mid-rebase or merge
59+
non-clean-behaviour Get the current behavior when the repository is mid-rebase or merge
60+
set-non-clean-behaviour Set the current behavior when the repository is mid-rebase or merge
6161
generate Generate a file version of available authors
6262
available List available authors
6363
example Print example mit toml file

docs/binaries/git-mit.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ Options:
1919
[env: GIT_MIT_AUTHORS_CONFIG=] [default:
2020
$HOME/.config/git-mit/mit.toml]
2121
-e, --exec <EXEC> Execute a command to generate the mit configuration, stdout will be
22-
captured and used instead of the file, if both this and the file is
23-
present, this takes precedence [env: GIT_MIT_AUTHORS_EXEC=]
22+
captured and used instead of the file, if both this and the file
23+
are present, this takes precedence [env: GIT_MIT_AUTHORS_EXEC=]
2424
-t, --timeout <TIMEOUT> Number of minutes to expire the configuration in [env:
2525
GIT_MIT_AUTHORS_TIMEOUT=] [default: 60]
2626
--completion <COMPLETION> Shell to generate completions for [possible values: bash, elvish,

docs/binaries/mit-prepare-commit-msg.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,17 @@ Arguments:
2929
3030
Options:
3131
--relates-to-exec <RELATES_TO_EXEC>
32-
A command to execute to get the value for the relates to trailer
32+
A command to execute to get the value for the "relates to" trailer
3333
3434
[env: GIT_MIT_RELATES_TO_EXEC=]
3535
3636
--relates-to-template <RELATES_TO_TEMPLATE>
37-
A template to apply to the relates to trailer
37+
A template to apply to the "relates to" trailer
3838
3939
[env: GIT_MIT_RELATES_TO_TEMPLATE=]
4040
4141
--non-clean-behaviour-option <NON_CLEAN_BEHAVIOUR_OPTION>
42-
A template to apply to the relates to trailer
42+
What to do when we rebase
4343
4444
[env: GIT_MIT_SET_NON_CLEAN_BEHAVIOUR=]
4545

docs/lints/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -392,7 +392,7 @@ The style from the git book, but that doesn't affect using git
392392

393393
##### subject-line-not-capitalized
394394

395-
Detect a subject line that is not capitalised
395+
Detect a subject line that is not capitalized
396396

397397
###### Default status
398398

@@ -480,7 +480,7 @@ git mit-config lint disable subject-line-not-capitalized
480480

481481
##### subject-line-ends-with-period
482482

483-
Detect a subject line that is not capitalised
483+
Detect a subject line that is not capitalized
484484

485485
###### Default status
486486

docs/mit-relates-to.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This is the `git mit-relates-to` part of the tool.
44

55
## Setup
66

7-
In order to get started with this tool you'll need a git repository
7+
To get started with this tool you'll need a git repository
88

99
``` shell,script(name="init-repo",expected_exit_code=0)
1010
git init .
@@ -19,8 +19,8 @@ git mit-install
1919
## Running the command
2020

2121
In projects, it is nice to help out your co-workers by linking the
22-
commits you're making back to issue in the backlog. Be very easy to
23-
forget though, so here's a command to automate it.
22+
commits you're making back to the issue in the backlog. It's easy to
23+
forget to include this, so here's a command to automate it.
2424

2525
Say you've just made this awesome `README.md` for Pivotal Tracker ID
2626
`[#12321513]`

docs/mit.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This is the `git mit` part of the tool.
44

55
## Setup
66

7-
In order to get started with this tool you'll need a git repository
7+
To get started with this tool you'll need a git repository
88

99
``` shell,script(name="init-repo",expected_exit_code=0)
1010
git init .
@@ -238,7 +238,7 @@ git mit-config mit set-non-clean-behaviour no-change
238238
git mit-config mit non-clean-behaviour
239239
```
240240

241-
To get the current behaviour run
241+
To get the current behavior run
242242

243243
``` text,verify(script_name="set-non-clean-behavior-no-change",stream=stdout)
244244
no-change

0 commit comments

Comments
 (0)