dotnet / dotnet/msbuild

Discussion: Enabling SourceLink by default

Open
#3,216 0 comments 1 reaction 0 assignees View on GitHub
triaged
Dominant language
C#
Stars
5.5k
Forks
1.5k
Avg merge
1d 13h
Merged PRs (30d)
133

Description

SourceLink is a really useful feature when debugging libraries you acquire via a packaging system. In fact, it's really great even for your own source code if you for example pick your binary bits from a build location other than yours (like maybe in a cached-build system).

It'd be really useful if we could enable SourceLink by default such that developers don't forget to opt-in to this experience. I'm usually not one for pushing features by default, but this one is so useful that I think it'd be a great default, just like for example generating PDBs is.

I can imagine some developers maybe reticent adding urls to their code for whatever reason, but they would be able to turn it off.

Changing defaults is hard, but this would be a change for the better.

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue does not name files, tests, or an entry point. First locate where SourceLink and related build defaults are configured, then determine how default changes are validated. Done means SourceLink is enabled by default, can still be disabled, and the behavior is covered by appropriate tests and documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
build-system
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.