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

Add VS Code contributing instructions #47119

Merged
merged 4 commits into from
Aug 25, 2020
Merged

Conversation

RikkiGibson
Copy link
Contributor

1. Install [VS Code](https://code.visualstudio.com/Download)
- After you install VS Code, install the [C# extension](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp)
- Important tip: You can look up editor commands by name by hitting *Ctrl+Shift+P*, or by hitting *Ctrl+P* and typing a `>` character. This will help you get familiar with editor commands mentioned below. On a Mac, use *⌘* instead of *Ctrl*.
2. Install a recent preview [.NET Core SDK](https://dotnet.microsoft.com/download/dotnet-core). At time of writing, Roslyn uses .NET 5 preview 7. The exact version in use is recorded in our [global.json](https://github.com/dotnet/roslyn/blob/master/global.json) file.
Copy link
Member

Choose a reason for hiding this comment

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

Hmm, worried this creates another place where we have to remember to update the SDK info when we move to new SDKs. Not sure how to fix this.

Copy link
Member

Choose a reason for hiding this comment

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

Perhaps we should just make these 2 documents 1 document, with separate Windows and Unix sections in it. Then we can just have 1 section in that document with "Install the .NET SDK (windows link, mac link, linux link)"?

Copy link
Contributor Author

@RikkiGibson RikkiGibson Aug 25, 2020

Choose a reason for hiding this comment

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

We reference global.json as our source of truth here, as we do in our build scripts. I wrote this assuming the documentation will fall out of date with the truth. We can alternatively either refrain from referencing a specific version in this document, or we can write a script that fails the build if documentation references a different SDK version than is referenced in global.json :P

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Perhaps we should just make these 2 documents 1 document

I think this might be reasonable to do in a future PR.

Co-authored-by: Fred Silberberg <frsilb@microsoft.com>
@RikkiGibson
Copy link
Contributor Author

Correctness failure is unrelated and solved by #47122

@RikkiGibson
Copy link
Contributor Author

Spanish failure is due to a known issue.

@RikkiGibson RikkiGibson merged commit 3ff70dd into master Aug 25, 2020
@ghost ghost added this to the Next milestone Aug 25, 2020
@RikkiGibson RikkiGibson deleted the dev/rigibson/vscode-contrib branch August 25, 2020 20:47
@jaredpar
Copy link
Member

@RikkiGibson

Spanish failure is due to a known issue.

And the bug for the known issue is ?

@RikkiGibson
Copy link
Contributor Author

RikkiGibson commented Aug 25, 2020

There are two issues at play. The first and most important is that management of flaky test issues and their failure rates is not automated. (the History tab in Azdo afaik commits the cardinal sin of recording a success when we failed and had to rerun.) The second is #47126.

We have about 100 flaky test bugs in-repo. I think we're getting to the point where we need to start investing in a triage/tracking/automation strategy for these bugs.

@jaredpar
Copy link
Member

I'm working on auto-tracking and triaging. Going to take some time to come online though.

@RikkiGibson
Copy link
Contributor Author

Also tagging the issue dotnet/roslyn-tools#799

@allisonchou allisonchou modified the milestones: Next, 16.8.P3 Aug 31, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants