Skip to content

Commit ef77b24

Browse files
Merge pull request #3 from dscho/contributing
CONTRIBUTING.md: add guide for first-time contributors
2 parents c2a2fd5 + de2ae42 commit ef77b24

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ Get the Source
1010
--------------
1111

1212
Clone the [GitForWindows repository on GitHub](https://github.com/git-for-windows/git).
13-
It is helpful create your own fork for storing your development branches.
13+
It is helpful to create your own fork for storing your development branches.
1414

15-
Windows uses CRLF line endings, while Unix systems just use LF. See
15+
Windows uses different line endings than Unix systems. See
1616
[this GitHub article on working with line endings](https://help.github.com/articles/dealing-with-line-endings/#refreshing-a-repository-after-changing-line-endings)
17-
if you have trouble.
17+
if you have trouble with line endings.
1818

1919
Build the Source
2020
----------------
@@ -23,7 +23,7 @@ First, download and install the latest [Git for Windows SDK (64-bit)](https://gi
2323
When complete, you can run the Git SDK, which creates a new Git Bash terminal window with
2424
the additional development commands, such as `make`.
2525

26-
The SDK uses a different credential manager, so you may still want to use normal Git
26+
As of time of writing, the SDK uses a different credential manager, so you may still want to use normal Git
2727
Bash for interacting with your remotes. Alternatively, use SSH rather than HTTPS and
2828
avoid credential manager problems.
2929

@@ -32,7 +32,7 @@ Here are some helpful variations:
3232

3333
* `make -j[N] DEVELOPER=1`: Compile new sources using up to N concurrent processes.
3434
The `DEVELOPER` flag turns on all warnings; code failing these warnings will not be
35-
accepted upstream.
35+
accepted upstream ("upstream" = "the core Git project").
3636
* `make clean`: Delete all compiled files.
3737

3838
When running `make`, you can use `-j$(nproc)` to automatically use the number of processors
@@ -108,7 +108,7 @@ You can also look at [the unofficial Chromium issues page](https://crbug.com/git
108108
multi-platform issues. You can look at recent user questions on
109109
[the Git mailing list](https://public-inbox.org/git).
110110

111-
Here at Microsoft, we are focused almost entirely on [improving performance](https://blogs.msdn.microsoft.com/devops/2018/01/11/microsofts-performance-contributions-to-git-in-2017/).
111+
Or you can "scratch your own itch", i.e. address an issue you have with Git. The team at Microsoft where the Git for Windows maintainer works, for example, is focused almost entirely on [improving performance](https://blogs.msdn.microsoft.com/devops/2018/01/11/microsofts-performance-contributions-to-git-in-2017/).
112112
We approach our work by finding something that is slow and try to speed it up. We start our
113113
investigation by reliably reproducing the slow behavior, then running that example using
114114
the MSVC build and tracing the results in PerfView.

0 commit comments

Comments
 (0)