Conversation
…sion recommendations Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request enhances the README documentation with better organization and adds missing content, while restoring the C# DevKit extension in the workspace configuration.
Changes:
- Reorganized README with new section structure: Tools Setup, Git Setup, Project Workspace Setup, GitHub Local Actions Setup, GitHub Setup, Branching Workflow, and GitHub Actions Workflow
- Corrected spelling error from "Nuget" to "NuGet"
- Added spell checker words for personal names and git-related terms
- Restored ms-dotnettools.csdevkit extension and alphabetically sorted all extension recommendations
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Restructured documentation with clearer section hierarchy, added detailed setup instructions for tools, Git, GitHub actions, and workflow guidance; corrected NuGet capitalization |
| ProjectTemplate.code-workspace | Added spell checker words ("gpgsign", "Pieter", "signingkey", "Viljoen"), restored C# DevKit extension, and alphabetically sorted extension recommendations |
* Branding Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com> * Allow only squash merging Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com> --------- Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
README.md:126
- The reference to 'GitHub Local Actions Settings / Secrets' on line 126 is inconsistent with the new structure. According to the updated GitHub Local Actions Setup section (lines 114-116), local secrets should be saved for ACT, not under a separate 'GitHub Local Actions Settings / Secrets' menu. This line should either be removed or updated to clarify where ACT local secrets are configured.
- Create a [NuGet API Key](https://www.nuget.org/account/apikeys).
- Save the Key as `NUGET_API_KEY` in:
- GitHub project security Settings / Secrets / Actions.
- GitHub project security Settings / Secrets / Dependabot.
- GitHub Local Actions Settings / Secrets.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Enhance the README with detailed setup instructions for tools, Git, and GitHub actions. Restore the C# devkit in the workspace configuration and correct spelling errors throughout the documentation.