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.

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

Update strategies doc #1485

Merged
merged 2 commits into from
Nov 27, 2024
Merged

Update strategies doc #1485

merged 2 commits into from
Nov 27, 2024

Conversation

jssblck
Copy link
Member

@jssblck jssblck commented Nov 27, 2024

Overview

It was brought to our attention that the docs for nuget strategies were incorrect: they said the nuget strategies are dynamic but they're actually static.

This PR updates that listing and overhauls the table in an attempt to make the dynamic vs static relationship more clear. Note: I did not double check every strategy; I just went off what we currently listed in that doc.

Rendered preview here.

Screenshot 2024-11-27 at 1 02 00 PM

@jssblck jssblck requested a review from a team as a code owner November 27, 2024 20:43
@jssblck jssblck requested a review from csasarak November 27, 2024 20:43

| Language/Package Manager | Kind of analysis | Detect Vendored Code |
|-------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|----------------------|
| [C#](https://github.com/fossas/fossa-cli/tree/master/docs/references/strategies/languages/dotnet) | Static | ❌ |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Question] Is Nuget always what's used for C#? I don't need this resolved for approval but it feels like the package manager or NuGet is the right thing to put here vs. the language.

Copy link
Member Author

@jssblck jssblck Nov 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's a little strange. first: no, nuget isn't the only package manager for C# or .NET generally. But inside FOSSA CLI we group all the tactics for .NET under the Nuget module, e.g. Strategy.NuGet.Paket.

i do think it probably makes more sense to refer to the package manager in this table like we do for other languages, but i didn't make that change here to minimize change/confusion.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've gone ahead and updated these to match the other package managers in the table: C# was the only odd one out.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that looks good, thanks!

@jssblck jssblck enabled auto-merge (squash) November 27, 2024 21:02
@jssblck jssblck merged commit 4ed7eab into master Nov 27, 2024
19 checks passed
@jssblck jssblck deleted the docs/nuget branch November 27, 2024 21:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants