Conversation
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 reorganizes and improves the README.md documentation structure and updates the VSCode workspace configuration. The changes focus on better organizing developer setup instructions and consolidating configuration management.
Changes:
- Restructured README with clearer section hierarchy for developer environment setup
- Consolidated Git configuration instructions with improved ordering and clarity
- Moved GitHub Local Actions setup into developer environment setup with expanded details
- Alphabetized VSCode extension recommendations in workspace file
- Added spell-check dictionary entries for new terms used in the documentation
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Reorganized developer setup sections with clearer hierarchy, improved Git/SSH setup flow, added branching and workflow documentation |
| ProjectTemplate.code-workspace | Alphabetized extension recommendations and added spell-check entries for "gpgsign", "Pieter", "signingkey", and "Viljoen" |
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 no new comments.
Comments suppressed due to low confidence (1)
README.md:126
- This line references 'GitHub Local Actions Settings / Secrets' which was removed from other parts of the documentation. The NUGET_API_KEY should not be stored in GitHub Local Actions Settings / Secrets based on the reorganization where local secrets are now documented separately in the GitHub Local Actions Setup section. This line should be removed to maintain consistency with the new documentation structure.
- GitHub Local Actions Settings / Secrets.
ptr727
enabled auto-merge
January 15, 2026 19:15
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.
Signed-off-by: Pieter Viljoen ptr727@users.noreply.github.com