Conversation
…sion recommendations Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
* 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>
Clarify the requirements for merge rules in the README and ensure all general merge types are enabled for rulesets to be honored. --------- Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
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
This PR improves the README documentation by reorganizing setup instructions into clear sections, updating GitHub project configuration guidance, adding branching workflow documentation, and standardizing extension recommendations in the workspace file.
Changes:
- Restructured developer environment setup into distinct sections: Tools Setup, Git Setup, Project Workspace Setup, and GitHub Local Actions Setup
- Consolidated GitHub-related configuration into a dedicated "GitHub Setup" section
- Added new sections for Branching Workflow and GitHub Actions Workflow best practices
- Updated workspace spelling dictionary and alphabetized extension recommendations
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Reorganized setup instructions into logical sections, updated GitHub project settings documentation, and added workflow guidance |
| ProjectTemplate.code-workspace | Added spelling dictionary entries for new names and git-related terms, alphabetized extension recommendations |
Comments suppressed due to low confidence (1)
README.md:127
- The instruction to save the NuGet API Key in 'GitHub Local Actions Settings / Secrets' is inconsistent with the refactored documentation structure. Lines 115-117 now handle local secrets setup (Docker Hub and GitHub tokens) in the 'GitHub Local Actions Setup' section, but the NuGet API Key at line 127 still references 'GitHub Local Actions Settings / Secrets'. Either this line should be removed (since NuGet keys are only needed in GitHub, not locally), or if local NuGet keys are needed, line 127 should be updated to align with the new documentation pattern established in lines 115-117.
- 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 for clarity and consistency, update workspace setup instructions, and standardize branding. Adjust merge rules and clarify requirements to ensure proper project management. Include extension recommendations for improved development experience.