Skip to content
This repository has been archived by the owner on Apr 16, 2020. It is now read-only.

Commit

Permalink
add code of conduct
Browse files Browse the repository at this point in the history
  • Loading branch information
ctaggart committed Jan 6, 2018
1 parent e233b08 commit d680a2e
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 7 deletions.
5 changes: 5 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant
to clarify expected behavior in our community.
For more information, see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
25 changes: 18 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@

# SourceLink
<img src="https://ctaggart.github.io/SourceLink/SourceLink128.jpg" align="right">
Source link support allows source code to be downloaded on demand while debugging. SourceLink is a set of build tools to help create and test for source link support.
Source link support allows source code to be downloaded on demand while debugging. SourceLink is a set of build tools to help create and test for source link support. [Source link support](https://github.com/dotnet/core/blob/master/Documentation/diagnostics/source_link.md) is a developer productivity feature that allows unique information about an assembly's original source code to be embedded in its PDB during compilation.

Additional [documentation is on the wiki](https://github.com/ctaggart/SourceLink/wiki).
## .NET Foundation

SourceLink is a [.NET Foundation](http://www.dotnetfoundation.org/projects) project. It [joined](http://www.dotnetfoundation.org/blog/2017/11/16/welcome-dnn-nunit-ironpython-mvvmcross-sourcelink-ilmerge-and-humanizer-to-the-net-foundation) in 2017-11.

## License

SourceLink is licensed under the [MIT license](LICENSE).

Here is the [General, Debugging, Options Dialog Box](https://docs.microsoft.com/en-us/visualstudio/debugger/general-debugging-options-dialog-box) from Visual Studio 2017:
![image](https://cloud.githubusercontent.com/assets/80104/23337630/001cedb6-fbba-11e6-9c44-68f4c826470c.png)
Expand Down Expand Up @@ -40,27 +46,28 @@ The [source link documention](https://github.com/dotnet/core/blob/master/Documen
</Project>
```

If you are building on Windows, make sure that you configure git to checkout files with [core.autocrlf input](https://github.com/ctaggart/SourceLink/wiki/Line-Endings).

By default `SourceLink.Create.CommandLine` will try to process GitHub and BitBucket cloned repositories. You can specify a specific server type by setting the `SourceLinkServerType` MSBuild property like `/p:SourceLinkServerType=GitHub`, `/p:SourceLinkServerType=BitBucket`, `/p:SourceLinkServerType=BitBucketServer` or `/p:SourceLinkServerType=GitLab`.

You can control when it runs by setting the `SourceLinkCreate` property. That property is set to `true` by default on build servers that set `CI` or `BUILD_NUMBER` environment variables. In general these tools are meant to be run only on build servers, but you can test locally by setting an MSBuild property like `/p:ci=true` or `/p:SourceLinkCreate=true`.
You can control when it runs by setting the MSBuild property `/p:SourceLinkCreate=true`. That property is set to `true` by default on build servers that set `CI` or `BUILD_NUMBER` environment variables. In general these tools are meant to be run only on build servers.

If you have a dotnet project, you can test locally with:
``` ps1
dotnet restore
dotnet build /p:ci=true /v:n
dotnet build /p:SourceLinkCreate=true /v:n
```
With an full framework project, you can test locally with:
``` ps1
msbuild /t:restore
msbuild /t:rebuild /p:ci=true /v:n
msbuild /t:rebuild /p:SourceLinkCreate=true /v:n
```

## examples
- [Rx.NET](https://github.com/ctaggart/SourceLink/issues/167#issuecomment-297423617)
- [ASP.NET MVC](https://github.com/ctaggart/SourceLink/issues/173)

## documentation
Additional [documentation is on the wiki](https://github.com/ctaggart/SourceLink/wiki).

# Test

`dotnet sourcelink test` is a tool you can use to test that the source link works. Source link support and this tool are not tied to git at all. It makes sure all links work for every source file in the PDB that is not embedded. You can test a nupkg, a pdb, or a dll if the pdb is embedded. Run `dotnet sourcelink` for a list of other diagnostic commands and additional help.
Expand Down Expand Up @@ -122,3 +129,7 @@ If you are using `SourceLink.Create.CommandLine` and [Paket](https://fsprojects.
- Visual Studio does not debug into embedded source files

Update to Visual Studio 2017 15.5 or later. Support [was added](https://visualstudio.uservoice.com/forums/121579-visual-studio-ide/suggestions/19107733-debugger-should-support-c-compiler-embed-optio).

# Community
This project has adopted the code of conduct defined by the [Contributor Covenant](http://contributor-covenant.org/)
to clarify expected behavior in our community. For more information, see the [.NET Foundation Code of Conduct](http://www.dotnetfoundation.org/code-of-conduct).

0 comments on commit d680a2e

Please sign in to comment.