You can contribute to .NET Core with issues and PRs. Simply filing issues for problems you encounter is a great way to contribute. Contributing implementations is greatly appreciated.
We use and recommend the following workflow:
git checkout -b mybranch
).
If you are having difficulty debugging changes to the library, you may want to incorporate the logging messages into your test session. To do so, set the debugOn flag to true Here. Note that the runtime and sdk extensions can be tested (with breakpoints as well, through the .js files) using their corresponding workspace and launch profiles by opening their root folders in vscode. For the library, those tests are reachable by going through the runtime extension workspace and adding the runtime-library folder to the workspace. But logging may be a better approach to debug this code.
If you are having difficulty debugging all other changes, note that you can add breakpoints into the tests for the library, runtime, or SDK by opening their corresponding workspace folder and launching the debug tab for their tests in VS Code. If you want to breakpoint the code, you’ll need to breakpoint the test in typescript, but then every reload add breakpoints to the JS code generated from the typescript code if you want to debug code outside of the tests thesmelves that the tests run.
Note: It is OK for your PR to include a large number of commits. Once your change is accepted, you will be asked to squash your commits into one or some appropriately small number of commits before your PR is merged.
Note: It is OK to create your PR as “[WIP]” on the upstream repo before the implementation is done. This can be useful if you’d like to start the feedback process concurrent with your implementation. State that this is the case in the initial PR comment.
Before making a pull request, be sure to build and test your changes locally with the build script (windows, mac) and test script (windows, mac). To lint your changes, run the test script with the parameter --tslint
You can also test only a specific set of tests using the following parameters with the test script:
Test SDK Extension Only: test sdk
(Tests the SDK extension only.)
Test SDK Extension Only: test rnt
(Tests the runtime extension only.)
Test SDK Extension Only: test lib
(Tests the library only.)
To build an installable .vsix file locally, navigate to the directory containing the extension’s package.json (either vscode-dotnet-runtime-extension
or vscode-dotnet-sdk-extension
) run the following commands:
npm install -g vsce
vsce package --ignoreFile ../.vscodeignore --yarn
The dotnet continuous integration (CI) system will automatically perform the required builds and run tests (including the ones you are expected to run) for PRs. Builds and test runs must be clean.
If the CI build fails for any reason, the PR issue will be updated with a link that can be used to determine the cause of the failure.
Microsoft team and community members will provide feedback on your change. Community feedback is highly valued. You will often see the absence of team feedback if the community has already provided good review feedback.
1 or more Microsoft team members will review every PR prior to merge. They will often reply with “LGTM, modulo comments”. That means that the PR will be merged once the feedback is resolved. “LGTM” == “looks good to me”.
There are lots of thoughts and approaches for how to efficiently discuss changes. It is best to be clear and explicit with your feedback. Please be patient with people who might not understand the finer details about your approach to feedback.
Use “Squash and Merge” by default for individual contributions unless requested by the PR author. Do so, even if the PR contains only one commit. It creates a simpler history than “Create a Merge Commit”. Reasons that PR authors may request “Merge and Commit” may include (but are not limited to):
git bisect
.