Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rewrite CONTRIBUTING.md to be a guide for new developers on Windows #1529

Merged
merged 4 commits into from
Mar 7, 2018
Merged

Rewrite CONTRIBUTING.md to be a guide for new developers on Windows #1529

merged 4 commits into from
Mar 7, 2018

Conversation

derrickstolee
Copy link

Git was originally designed for Unix systems and still today, all the build tools for the Git
codebase assume you have standard Unix tools available in your path. If you have an open-source
mindset and want to start contributing to Git, but primarily use a Windows machine, then you may
have trouble getting started. This guide is for you.

This pull request renames CONTRIBUTING.md to CODE_OF_CONDUCT.md and replaces CONTRIBUTING.md with content that may help new developers working on Git.

@derrickstolee
CODE_OF_CONDUCT: Rename CONTRIBUTING.md to CODE_OF_CONDUCT.md
ca87a55 
The current CONTRIBUTING.md file is actually a code of conduct. This is
a valuable document, but is misnamed. A following patch will replace
CONTRIBUTING.md with a guide to contributing to Git using a Windows machine.

Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
@derrickstolee derrickstolee force-pushed the contributing branch 2 times, most recently from beb4a65 to f04e4d1 Compare March 1, 2018 17:17
avivey
avivey reviewed Mar 1, 2018
View reviewed changes
CONTRIBUTING.md Outdated
If you prefer, you can use a virtual machine (VM) to run Linux and test your changes in the
full environment. I like this setup, particularly because the test suite runs a lot faster
on Linux than on Windows or with the WSL. I connect to the VM using an SSH terminal like
[PuTTY](http://www.putty.org/). I've tried to make the following steps be as clear as

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

avivey
avivey reviewed Mar 1, 2018
View reviewed changes
CONTRIBUTING.md Outdated
In order to build and use `git`, you will need the following libraries via `apt-get`:

```
sudo apt-get update

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

avivey
avivey reviewed Mar 1, 2018
View reviewed changes
CONTRIBUTING.md Outdated
[PuTTY](http://www.putty.org/). I've tried to make the following steps be as clear as
possible, without missing any steps.

* [Download an Ubuntu Server ISO](https://www.ubuntu.com/download/server).

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

CONTRIBUTING.md Outdated
Be sure to clone into `/home/[user]/` and not into any folder under `/mnt/?/` or your build
will fail due to colons in file names.

### Using a Linux Virtual Machine with Hyper-V

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

CONTRIBUTING.md Outdated
a repo with ~1 million entries in the index. `inflate-repo.sh` will use an existing repo
and copy the current work tree until it is a specified size.

Test Your Changes on Linux

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

CONTRIBUTING.md Outdated
* If the service is not found, install with `sudo apt-get install openssh-server`.
* If the service is not running, then use `sudo service ssh start`.
* Use `shutdown -h now` to shutdown the VM, go to the Hyper-V settings for the VM, expand Network Adapter
to select "Advanced Features", and set the MAC address to be static (this can save your VM from losing

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

bbolli
bbolli reviewed Mar 2, 2018
View reviewed changes
CONTRIBUTING.md Outdated
You should now be ready to type `make` from the root of your `git` source directory.
Here are some helpful variations:

* `make -j[N] DEVELOPER=1`: Compile new sources using up to N concurrent processes.

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

@dscho
Copy link
Member

dscho commented Mar 2, 2018

Obviously, I like the renaming step, as I suggested it (during informal pre-review). Here is a note to myself that I also have to see whether we need to update any reference to the code of conduct.

@derrickstolee
CONTRIBUTING.md: add guide for first-time contributors
c2a2fd5 
Getting started contributing to Git can be difficult on a Windows machine.
CONTRIBUTING.md contains a guide to getting started, including detailed
steps for setting up build tools, running tests, and submitting patches
to upstream.

Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
@dscho
fixup! CONTRIBUTING.md: add guide for first-time contributors
de2ae42 
A couple of suggested touchups.

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
@dscho
Copy link
Member

dscho commented Mar 6, 2018

I offered a couple of tiny modifications at derrickstolee#3

@derrickstolee could you have a look?

@derrickstolee
Merge pull request #3 from dscho/contributing
ef77b24 
CONTRIBUTING.md: add guide for first-time contributors
@derrickstolee derrickstolee merged commit b34b95c into git-for-windows:master Mar 7, 2018
@dscho
Copy link
Member

dscho commented Mar 7, 2018

Could I ask you to rebase (with --auto-squash)?

dscho added a commit that referenced this pull request Mar 23, 2018
@dscho
Merge pull request #1529 from derrickstolee/contributing
29dcfc1 
Rewrite CONTRIBUTING.md to be a guide for new developers on Windows
dscho added a commit that referenced this pull request Apr 3, 2018
@dscho
Merge pull request #1529 from derrickstolee/contributing
10ad06b 
Rewrite CONTRIBUTING.md to be a guide for new developers on Windows
dscho added a commit that referenced this pull request May 29, 2018
@dscho
Merge pull request #1529 from derrickstolee/contributing
b3c14b8 
Rewrite CONTRIBUTING.md to be a guide for new developers on Windows
dscho added a commit that referenced this pull request May 29, 2018
@dscho
Merge pull request #1529 from derrickstolee/contributing
64bf490 
Rewrite CONTRIBUTING.md to be a guide for new developers on Windows
PKRoma pushed a commit to PKRoma/git-for-windows that referenced this pull request Jun 22, 2018
@dscho
Merge pull request git-for-windows#1529 from derrickstolee/contributing
7e50ceb 
Rewrite CONTRIBUTING.md to be a guide for new developers on Windows
PKRoma pushed a commit to PKRoma/git-for-windows that referenced this pull request Jun 22, 2018
@dscho
Merge pull request git-for-windows#1529 from derrickstolee/contributing
9c0bb61 
Rewrite CONTRIBUTING.md to be a guide for new developers on Windows
PKRoma pushed a commit to PKRoma/git-for-windows that referenced this pull request Jun 22, 2018
@dscho
Merge pull request git-for-windows#1529 from derrickstolee/contributing
131a35c 
Rewrite CONTRIBUTING.md to be a guide for new developers on Windows
dscho added a commit that referenced this pull request Aug 22, 2018
@dscho
Merge pull request #1529 from derrickstolee/contributing
84f5036 
Rewrite CONTRIBUTING.md to be a guide for new developers on Windows
dscho added a commit to dscho/git that referenced this pull request Aug 22, 2018
@dscho
Merge pull request git-for-windows#1529 from derrickstolee/contributing
2b8d569 
Rewrite CONTRIBUTING.md to be a guide for new developers on Windows
dscho added a commit that referenced this pull request Aug 23, 2018
@dscho
Merge pull request #1529 from derrickstolee/contributing
2eeaf42 
Rewrite CONTRIBUTING.md to be a guide for new developers on Windows
dscho added a commit that referenced this pull request Aug 23, 2018
@dscho
Merge pull request #1529 from derrickstolee/contributing
b41d2c2 
Rewrite CONTRIBUTING.md to be a guide for new developers on Windows
dscho added a commit that referenced this pull request Aug 23, 2018
@dscho
Merge pull request #1529 from derrickstolee/contributing
f56578d 
Rewrite CONTRIBUTING.md to be a guide for new developers on Windows
jamill pushed a commit to jamill/git that referenced this pull request Aug 28, 2018
@dscho @jamill
Merge pull request git-for-windows#1529 from derrickstolee/contributing
2ab43ee 
Rewrite CONTRIBUTING.md to be a guide for new developers on Windows
jamill pushed a commit to jamill/git that referenced this pull request Sep 5, 2018
@dscho @jamill
Merge pull request git-for-windows#1529 from derrickstolee/contributing
67c2d6c 
Rewrite CONTRIBUTING.md to be a guide for new developers on Windows
git-for-windows-ci pushed a commit that referenced this pull request Sep 10, 2018
@dscho
Merge pull request #1529 from derrickstolee/contributing
d6c9b06 
Rewrite CONTRIBUTING.md to be a guide for new developers on Windows
jamill pushed a commit to jamill/git that referenced this pull request Sep 11, 2018
@dscho @jamill
Merge pull request git-for-windows#1529 from derrickstolee/contributing
91c9ce2 
Rewrite CONTRIBUTING.md to be a guide for new developers on Windows
git-for-windows-ci pushed a commit that referenced this pull request Sep 24, 2018
@dscho
Merge pull request #1529 from derrickstolee/contributing
d128559 
Rewrite CONTRIBUTING.md to be a guide for new developers on Windows
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@avivey avivey avivey left review comments

@dscho dscho dscho left review comments

@bbolli bbolli bbolli left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@derrickstolee @dscho @bbolli @avivey