You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -81,9 +81,9 @@ If you want to contribute a new package, be sure to
81
81
82
82
- read and follow the [package development guide][stdlib-docs].
83
83
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,
85
85
86
-
- see the [git][git] docs.
86
+
- see the [Git][git] docs.
87
87
- try a tutorial, such as the [tutorial][github-git-tutorial] provided by GitHub.
88
88
89
89
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
142
142
143
143
#### Step 4: Commit
144
144
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.
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].
160
160
161
161
#### Step 5: Sync
162
162
163
163
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:
164
164
165
165
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.
167
167
168
168
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.
169
169
@@ -176,7 +176,7 @@ $ git rebase upstream/develop
176
176
177
177
Tests should accompany **all** bug fixes and features. For guidance on how to write tests, consult existing tests within the project.
178
178
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,
180
180
181
181
```bash
182
182
$ make init
@@ -218,7 +218,7 @@ $ git commit
218
218
$ git push origin <branch>
219
219
```
220
220
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.
222
222
223
223
#### Step 9: Land
224
224
@@ -280,7 +280,7 @@ The project can **never** have enough tests. To address areas lacking sufficient
280
280
281
281
> By contributing documentation to the project, you are agreeing to release it under the project [license][stdlib-license].
282
282
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,
Copy file name to clipboardExpand all lines: docs/development.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -74,7 +74,7 @@ The following external libraries can be automatically downloaded and compiled fr
74
74
75
75
## Download
76
76
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.
78
78
79
79
<!-- run-disable -->
80
80
@@ -168,7 +168,7 @@ To initialize the development environment,
168
168
$ make init
169
169
```
170
170
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.
172
172
173
173
## Verification
174
174
@@ -235,7 +235,7 @@ workshops workshops
235
235
$ make install
236
236
```
237
237
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.
Copy file name to clipboardExpand all lines: docs/policies/domains.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ List of **currently** unused domains:
38
38
39
39
## Changes
40
40
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.
0 commit comments