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

Update CONTRIBUTING.md doc #1785

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update CONTRIBUTING.md doc #1785

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 5 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ But first things first...
* Make sure you fill in the earliest version that you know has the issue.
* Fork the repository on GitHub, then clone it using your favorite Git client.
* Make sure the project builds and all tests pass on your machine by running
the `buildandtest.cmd` script on Windows or `buildandtest.sh` on Linux/Mac.
`dotnet test LibGit2Sharp.sln`.
* Optionally install Visual Studio 2019 or a similar IDE.

## LibGit2

Expand All @@ -27,8 +28,8 @@ To build libgit2 see [here](https://github.com/libgit2/libgit2sharp/wiki/How-to-
## Making Changes

Make sure you have the required .NET Core SDK and runtimes installed.
The easiest way to do this is run our `tools\Install-DotNetSdk.ps1` script.
Using the `-InstallLocality Machine` switch requires elevation but ensures
The easiest way to do this is run our `init.ps1` (or `init.cmd`) script.
On Windows you can use the `-InstallLocality Machine` switch which requires elevation but ensures
that Visual Studio will be able to load the solution even when launched from a shortcut.

Then proceed to:
Expand All @@ -52,6 +53,7 @@ Some things that will increase the chance that your pull request is accepted.
* If code from elsewhere is used, proper credit and a link to the source should exist in the code comments.
Then licensing issues can be checked against LibGit2Sharp's very permissive MIT based open source license.
* Having a configured git client that converts line endings to LF. [See here.](https://help.github.com/articles/dealing-with-line-endings/).

# Additional Resources

* [General GitHub documentation](http://help.github.com/)
Expand Down