Skip to content

Commit 4173751

Browse files
committed
Fix capitalization
1 parent d61142c commit 4173751

7 files changed

Lines changed: 16 additions & 16 deletions

File tree

CONTRIBUTING.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,9 @@ If you want to contribute a new package, be sure to
8181

8282
- read and follow the [package development guide][stdlib-docs].
8383

84-
If you are unfamiliar with [git][git], the version control system used by GitHub and this project,
84+
If you are unfamiliar with [Git][git], the version control system used by GitHub and this project,
8585

86-
- see the [git][git] docs.
86+
- see the [Git][git] docs.
8787
- try a tutorial, such as the [tutorial][github-git-tutorial] provided by GitHub.
8888

8989
Next, take a look around the project, noting the style and organization of documentation, tests, examples, benchmarks, and source implementations. Consistency is highly **prioritized** within stdlib. Thus, the more you are able to match and adhere to project conventions and style, the more likely your contribution will be accepted. While we have done our best to automate linting and style guidelines, such automation is not perfect and cannot adequately capture the inevitable exceptions and nuance to many rules. In short, the more you study existing practice, the better prepared you will be to contribute to stdlib.
@@ -142,7 +142,7 @@ Start making your changes and/or implementing the new feature. Any text you writ
142142

143143
#### Step 4: Commit
144144

145-
Ensure that you have configured [git][git] to know your name and email address.
145+
Ensure that you have configured [Git][git] to know your name and email address.
146146

147147
```bash
148148
$ git config --global user.name "Jane Doe"
@@ -156,14 +156,14 @@ $ git add files/which/changed
156156
$ git commit
157157
```
158158

159-
When writing commit messages, follow the git [style guide][stdlib-style-guides].
159+
When writing commit messages, follow the Git [style guide][stdlib-style-guides].
160160

161161
#### Step 5: Sync
162162

163163
To incorporate recent changes from the `upstream` repository during development, you should [rebase][git-rebase] your local branch, reapplying your local commits on top of the current upstream `HEAD`. This procedure is in contrast to performing a standard [merge][git-merge], which may interleave development histories. The rationale is twofold:
164164

165165
1. interleaved histories make [squashing][git-rewriting-history] commits more difficult
166-
2. a standard merge increases the risk of incomplete/broken commits appearing in the git history.
166+
2. a standard merge increases the risk of incomplete/broken commits appearing in the [Git][git] history.
167167

168168
An ideal commit history is one in which, at no point in time, is the project in a broken state. While not always possible (mistakes happen), striving for this ideal facilitates time travel and software archeology.
169169

@@ -176,7 +176,7 @@ $ git rebase upstream/develop
176176

177177
Tests should accompany **all** bug fixes and features. For guidance on how to write tests, consult existing tests within the project.
178178

179-
**Before** submitting a [pull request][github-pull-request] to the `upstream` repository, ensure that all tests pass, including linting. If git hooks have been enabled,
179+
**Before** submitting a [pull request][github-pull-request] to the `upstream` repository, ensure that all tests pass, including linting. If [Git][git] hooks have been enabled,
180180

181181
```bash
182182
$ make init
@@ -218,7 +218,7 @@ $ git commit
218218
$ git push origin <branch>
219219
```
220220

221-
Note that, once a [pull request][github-pull-request] has been made (i.e., your local repository commits have been pushed to a remote server), you should **not** perform any further [rewriting][git-rewriting-history] of git history. If the history needs modification, a contributor will modify the history during the merge process. The rationale for **not** rewriting public history is that doing so invalidates the commit history for anyone else who has pulled your changes, thus imposing additional burdens on collaborators to ensure that their local versions match the modified history.
221+
Note that, once a [pull request][github-pull-request] has been made (i.e., your local repository commits have been pushed to a remote server), you should **not** perform any further [rewriting][git-rewriting-history] of [Git][git] history. If the history needs modification, a contributor will modify the history during the merge process. The rationale for **not** rewriting public history is that doing so invalidates the commit history for anyone else who has pulled your changes, thus imposing additional burdens on collaborators to ensure that their local versions match the modified history.
222222

223223
#### Step 9: Land
224224

@@ -280,7 +280,7 @@ The project can **never** have enough tests. To address areas lacking sufficient
280280

281281
> By contributing documentation to the project, you are agreeing to release it under the project [license][stdlib-license].
282282

283-
Project documentation is localized within each package. Similar to code, you should modify documentation using [git][git]. Provided you have followed the [development guide][stdlib-development] and enabled git hooks,
283+
Project documentation is localized within each package. Similar to code, you should modify documentation using [Git][git]. Provided you have followed the [development guide][stdlib-development] and enabled [Git][git] hooks,
284284

285285
```bash
286286
$ make init

docs/development.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ The following external libraries can be automatically downloaded and compiled fr
7474

7575
## Download
7676

77-
To acquire the source code, first navigate to the parent directory into which you want to place the project git repository. Because of this project's heavy reliance on [GNU make][make], the directory path should **not** include spaces or any other shell meta characters such as `$` or `:`, as these characters will cause [GNU make][make] and the installation process to fail.
77+
To acquire the source code, first navigate to the parent directory into which you want to place the project [Git][git] repository. Because of this project's heavy reliance on [GNU make][make], the directory path should **not** include spaces or any other shell meta characters such as `$` or `:`, as these characters will cause [GNU make][make] and the installation process to fail.
7878

7979
<!-- run-disable -->
8080

@@ -168,7 +168,7 @@ To initialize the development environment,
168168
$ make init
169169
```
170170

171-
Initializing the development environment configures git hooks and other bells and whistles to aid in development. Git hooks are especially important as they enable automatic linting and testing to ensure that code meets style specifications and does not break.
171+
Initializing the development environment configures [Git][git] hooks and other bells and whistles to aid in development. Git hooks are especially important as they enable automatic linting and testing to ensure that code meets style specifications and does not break.
172172

173173
## Verification
174174

@@ -235,7 +235,7 @@ workshops workshops
235235
$ make install
236236
```
237237

238-
will be enough to resolve these conflicts. Otherwise, remove the git repository, clone, and reinstall.
238+
will be enough to resolve these conflicts. Otherwise, remove the [Git][git] repository, clone, and reinstall.
239239

240240
## Editors
241241

docs/policies/domains.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ List of **currently** unused domains:
3838

3939
## Changes
4040

41-
This is a living document which may be periodically updated. Please refer to the [git history for this document][stdlib-git-commit-log-domains] to view the changes.
41+
This is a living document which may be periodically updated. Please refer to the [Git history for this document][stdlib-git-commit-log-domains] to view the changes.
4242

4343
## License
4444

tools/git/hooks/post-merge

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
# See the License for the specific language governing permissions and
1717
# limitations under the License.
1818

19-
# A git hook called by `git merge`, which runs when a `git pull` is performed on a local repository.
19+
# A Git hook called by `git merge`, which runs when a `git pull` is performed on a local repository.
2020
#
2121
# This hook is called with the following arguments:
2222
#

tools/git/hooks/pre-commit

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
# See the License for the specific language governing permissions and
1717
# limitations under the License.
1818

19-
# A git hook called by `git commit`. If this scripts exits with a non-zero status, the commit will be aborted.
19+
# A Git hook called by `git commit`. If this scripts exits with a non-zero status, the commit will be aborted.
2020
#
2121
# This hook is called with no arguments.
2222

tools/make/lib/node/npm.mk

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
# Define the version bump type (e.g., pre-patch, patch, pre-minor, minor, pre-major, major, pre-release):
2222
NPM_VERSION ?=
2323

24-
# Define a git commit message when incrementing the project version:
24+
# Define a Git commit message when incrementing the project version:
2525
NPM_VERSION_MESSAGE ?=
2626

2727
# Define command-line options when incrementing the project version:

tools/make/lib/stats/git.mk

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
# VARIABLES #
2222

23-
# Define the path to the directory containing scripts for mining the git repository:
23+
# Define the path to the directory containing scripts for mining the Git repository:
2424
GIT_SCRIPTS_DIR ?= $(TOOLS_DIR)/git/scripts
2525

2626
# Define a directory path for when listing contributors:

0 commit comments

Comments
 (0)