Conversation
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 pull request restructures the README to provide clearer, more organized developer setup instructions and adds comprehensive documentation for Git configuration, GitHub settings, and development workflows. The workspace configuration is updated to alphabetically sort extension recommendations and add necessary spelling dictionary entries.
Changes:
- Reorganized README sections with better hierarchy (Tools Setup, Git Setup, Project Workspace Setup, GitHub Local Actions Setup, GitHub Setup)
- Added new sections for Branching Workflow and GitHub Actions Workflow with best practice guidelines
- Moved GitHub Local Actions secrets documentation to the appropriate local setup section
- Alphabetically sorted VSCode extension recommendations in workspace file
- Added spelling dictionary entries for author name and git-related terms
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| README.md | Restructured developer setup sections, improved documentation organization, added branching and GitHub Actions workflow guidance, corrected duplicate entries |
| ProjectTemplate.code-workspace | Alphabetically sorted extension recommendations, added spelling dictionary entries for "Pieter", "Viljoen", "gpgsign", and "signingkey" |
| ssh-keyscan github.com >> ~/.ssh/known_hosts | ||
| ssh -v -T git@github.com | ||
| ``` | ||
| - Install VSCode and / or Visual Studio |
There was a problem hiding this comment.
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.
Suggested change
| - Install VSCode and / or Visual Studio | |
| - Install VS Code and / or Visual Studio |
|
|
||
| ### GitHub Secrets Setup | ||
|
|
||
| - Create a [Nuget API Key](https://www.nuget.org/account/apikeys). |
There was a problem hiding this comment.
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). |
| - Linux file modes: | ||
| - `chmod +x [filename.sh]` | ||
| - All shell files are `LF` mode. | ||
| - Linux / MacOS: |
There was a problem hiding this comment.
The official branding for Apple's operating system is "macOS" (lowercase 'm'), not "MacOS". This should be corrected to match Apple's official product naming.
Suggested change
| - Linux / MacOS: | |
| - Linux / macOS: |
This was referenced Jul 16, 2026
ptr727
added a commit
that referenced
this pull request
Jul 16, 2026
Incorporates the template-level gaps reported in #306 (surfaced adapting the template to Financial-Modeling, a source-only `uv`-managed Python repo that never publishes to PyPI). Downstream release standup (WORKFLOW.md, version.json + NBGV, source-only publisher, dependabot, uv.lock pin, README index row) is tracked in a separate Financial-Modeling issue. ## Changes (mapped to #306) 1. **`.editorconfig` comment inaccuracy** — the `[*]` "Defaults" comment claimed the LF exceptions mirror `.gitattributes`. They don't: the workflow-YAML pins (`.github/workflows/*` + catalog snippet workflows) are `.editorconfig`-only (git passive via `* -text`, CI-enforced). Reworded to distinguish the git-shared pins from the editorconfig-only ones. 2. **`uv.lock` LF pin** — added to both `.editorconfig` (`[uv.lock]`) and `.gitattributes` (`uv.lock text eol=lf`). `uv` regenerates the lockfile with LF on every platform, so a CRLF-default repo reds `editorconfig-checker` on every `uv lock`/`uv sync` until reconverted. Same rationale as the existing shebang/Dockerfile pins. 3. **Python VS Code tasks snippet** — new `catalog/snippets/configs/vscode-tasks-python.json`, the Python peer of the .NET `vscode-tasks.json`. All `type: process` (no `&&` chaining, which Windows PowerShell 5.1 rejects); ruff format/check, a type-check task, a sequenced `Python Verify` aggregator, `pytest`, and the shared Docker `Lint:` group. Referenced from `catalog/README.md` and the CODESTYLE Python loop. 4. **CODESTYLE Python section adapt-before-propagate** — added an adaptation callout enumerating the axes that vary per repo (type checker in CI, deps declaration, versioning/publishing, disabled markdownlint rules, VS Code config home), and softened the universal claims (pyright-strict baseline, `[dependency-groups]`, `_version.py`, PyPI publish, `uv build`) so a source-only / mypy-in-CI / PEP 621 repo is a first-class profile rather than a deviation that gets a verbatim copy rejected (the #10/#11 churn). 5. **VS Code config placement** — stated explicitly (callout + adaptation bullet): settings/extensions may live in `.vscode/*.json` **or** the `<Repo>.code-workspace`; tasks/launch/debug can only be external `.vscode/*.json`. 6. **`WORKFLOW.md` propagation** — the template ships it; propagation to Financial-Modeling (plus a README "Repository files" index row) is in the downstream standup issue. **Registry:** `Financial-Modeling` reclassified as a source-**release** repo (`releaseTrigger` `none` → `dispatch-only`); refreshed the stale driftNotes (PR CI now exists; the "no workflows yet" note was outdated). ## Validation - `editorconfig-checker:latest` — clean (new JSON is CRLF per the `[*]` default). - `markdownlint-cli2:latest` on `CODESTYLE.md` + `catalog/README.md` — 0 errors. - `registry/repos.json` — parses; `releaseTrigger` = `dispatch-only`. Closes #306. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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 the developer environment, Git configuration, and GitHub actions. Restore the C# devkit and correct spelling errors throughout the document. Update workspace recommendations to improve development efficiency.