-
Notifications
You must be signed in to change notification settings - Fork 0
Update README and workspace setup #11
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
Closed
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
76ccfff
Update readme and workspace
ptr727 b5e2fa4
Add C# devkit back
ptr727 6a32d47
readme
ptr727 5139a07
spelling
ptr727 0a1fe4b
readme
ptr727 1f4daa4
readme
ptr727 c4a51c7
readme
ptr727 cce42d3
Update readme and workspace (#10)
ptr727 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -20,43 +20,51 @@ Packages published on [NuGet](https://www.nuget.org/packages/ptr727.ProjectTempl | |||||
|
|
||||||
| ## Developer Environment Setup | ||||||
|
|
||||||
| - [Register](https://github.com/settings/keys) SSH Key on GitHub. | ||||||
| ### Tools Setup | ||||||
|
|
||||||
| ```shell | ||||||
| ssh-keygen -t ed25519 # If not already created | ||||||
| cat ~/.ssh/id_ed25519.pub | ||||||
| ssh-keyscan github.com >> ~/.ssh/known_hosts | ||||||
| ssh -v -T git@github.com | ||||||
| ``` | ||||||
| - Install VSCode and / or Visual Studio | ||||||
|
|
||||||
| - Add [SSH keys to GitHub](https://github.com/settings/keys), add both an authentication and a signing key. | ||||||
| - Configure git for [SSH signing](https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key): | ||||||
| ### Git Setup | ||||||
|
|
||||||
| - Configure Git options: | ||||||
|
|
||||||
| ```shell | ||||||
| git config --global credential.helper "cache --timeout=3600" | ||||||
| git config --global user.name "Pieter Viljoen" | ||||||
| git config --global user.email "ptr727@users.noreply.github.com" | ||||||
| git config --global core.sharedRepository group | ||||||
| git config --global --add safe.directory '*' | ||||||
| git config --list --show-origin | ||||||
| ``` | ||||||
|
|
||||||
| - [Register](https://github.com/settings/keys) SSH key for Authentication and Signing on GitHub. | ||||||
|
|
||||||
| ```shell | ||||||
| ssh-keygen -t ed25519 # If not already created | ||||||
| cat ~/.ssh/id_ed25519.pub # Paste into GitHub | ||||||
| ssh-keyscan github.com >> ~/.ssh/known_hosts | ||||||
| ssh -v -T git@github.com | ||||||
| ``` | ||||||
|
|
||||||
| - Configure git for [SSH signing](https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key): | ||||||
|
|
||||||
| ```shell | ||||||
| git config --global gpg.format ssh | ||||||
| cat ~/.ssh/id_ed25519.pub | ||||||
| git config --global user.signingkey "~/.ssh/id_ed25519.pub" | ||||||
| git config --global commit.gpgsign true | ||||||
| git config --global tag.gpgsign true | ||||||
|
|
||||||
| git show --show-signature # error: gpg.ssh.allowedSignersFile needs to be configured and exist for ssh signature verification | ||||||
| mkdir -p ~/.config/git | ||||||
| touch ~/.config/git/allowed_signers | ||||||
| git config --global gpg.ssh.allowedSignersFile "~/.config/git/allowed_signers" | ||||||
| echo "$(git config --get user.email) namespaces=\"git\" $(cat ~/.ssh/id_ed25519.pub)" >> ~/.config/git/allowed_signers | ||||||
| cat ~/.config/git/allowed_signers | ||||||
| git log --show-signature # Good "git" signature for ptr727@users.noreply.github.com with ED25519 key SHA256:[secret] | ||||||
|
|
||||||
| git config --global gpg.ssh.allowedSignersFile "~/.config/git/allowed_signers" | ||||||
| git log --show-signature | ||||||
| git config --list --show-origin | ||||||
| ``` | ||||||
|
|
||||||
| ### Project Workspace Setup | ||||||
|
|
||||||
| - New project: | ||||||
| - Create new project directory. | ||||||
| - Copy and rename template projects. | ||||||
|
|
||||||
| ```shell | ||||||
| git init | ||||||
|
|
@@ -68,28 +76,48 @@ Packages published on [NuGet](https://www.nuget.org/packages/ptr727.ProjectTempl | |||||
| dotnet husky add pre-commit -c "dotnet husky run" | ||||||
| ``` | ||||||
|
|
||||||
| - New deployment: | ||||||
| - New pull of existing project: | ||||||
|
|
||||||
| ```shell | ||||||
| dotnet tool restore | ||||||
| dotnet husky install | ||||||
| chmod +x ./.husky/pre-commit # Make sure file is executable in Linux | ||||||
| winget install nektos.act # Windows optional | ||||||
| ``` | ||||||
|
|
||||||
| - Update tools: | ||||||
| - Update tools in existing project: | ||||||
|
|
||||||
| ```shell | ||||||
| dotnet tool update --all | ||||||
| dotnet outdated --upgrade:prompt | ||||||
| winget upgrade nektos.act # Windows optional | ||||||
| ``` | ||||||
|
|
||||||
| - Linux file modes: | ||||||
| - `chmod +x [filename.sh]` | ||||||
| - All shell files are `LF` mode. | ||||||
| - Linux / MacOS: | ||||||
|
||||||
| - Linux / MacOS: | |
| - Linux / macOS: |
ptr727 marked this conversation as resolved.
Copilot
AI
Jan 15, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The official branding for NuGet has a capital 'N' and capital 'G'. This should be "NuGet" to match the official product name and be consistent with other uses in this file (lines 11, 13, 14).
Suggested change
| - Create a [Nuget API Key](https://www.nuget.org/account/apikeys). | |
| - Create a [NuGet API Key](https://www.nuget.org/account/apikeys). |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The official branding for Visual Studio Code is "VS Code" (with a space), not "VSCode". This should be corrected for consistency with Microsoft's official product naming.