Docs: Why is this guidance limited to open source?

Created on 17 Oct 2018  Â·  5Comments  Â·  Source: dotnet/docs

Much of this guidance is applicable to library authors regardless of whether the library is open source.


Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Area - .NET Guide P2 Pri2 doc-enhancement dotneprod waiting-on-feedback

Most helpful comment

So, maybe something as "Public .NET libraries guidance"?

All 5 comments

@JamesNK can you comment on this?

I tried to come up with a quick way to describe libraries that are released publicly and this guidance should be applied to, vs a C# libraries that are internal to an app and most of this guidance doesn't matter.

"Open source libraries" is the best descriptor I could think of to differentiate the two.

It makes sense, I just feel like most of this guidance is applicable to anything published to NuGet, regardless of whether its open source or not! There are a few exceptions (source linking, how to handle strong name key) but they seem relatively minor. Its great guidance and I'd like to make sure its as broadly discovered and internalized by the .NET community as possible. If you're not comfortable changing the wording around this and want to keep it limited to open source, then I think we can just close this issue.

So, maybe something as "Public .NET libraries guidance"?

Quite frankly, I believe we try too hard. The term "Library guidance" seems sufficient to me. I'd argue this guidance equally applies to internal libraries; but of course it might not be worth it. But I think customers should decide this for themselves.

Any objections to the rename?

Was this page helpful?
0 / 5 - 0 ratings

Related issues

JagathPrasad picture JagathPrasad  Â·  3Comments

FrancescoBonizzi picture FrancescoBonizzi  Â·  3Comments

garfbradaz picture garfbradaz  Â·  3Comments

LJ9999 picture LJ9999  Â·  3Comments

gmatv picture gmatv  Â·  3Comments