Conversation
This PR updates the codegen files. Co-authored-by: ptr727-codegen[bot] <275599072+ptr727-codegen[bot]@users.noreply.github.com>
This PR updates the codegen files. Co-authored-by: ptr727-codegen[bot] <275599072+ptr727-codegen[bot]@users.noreply.github.com>
This PR updates the codegen files. Co-authored-by: ptr727-codegen[bot] <275599072+ptr727-codegen[bot]@users.noreply.github.com>
…p carry, brownfield migration (#124) Folds three downstream-filed defects back into the template so future derived projects don't re-hit them. All three were surfaced while porting the template into KiCadLibrary (#116, #117) and Utilities (#111). ## #116 - shared markdownlint config - Add `.markdownlint-cli2.jsonc` at the repo root. Both the davidanson `markdownlint` IDE extension and CLI/CI `markdownlint-cli2` read it, so the IDE and command line stay in lock-step (previously a CLI run flagged MD013/MD033 errors the IDE showed clean). - Add `jsonc` to the `.editorconfig` `[*.{json,jsonc}]` glob so the new config is CRLF-governed. - Point `CODESTYLE.md` at the config as authoritative (kept local-only, no CI gate). ## #117 - make the verbatim-copy contract explicit (template docs only, no downstream files touched) - Mark the `AGENTS.md` "PR Review Etiquette" section and the `.github/copilot-instructions.md` "GitHub Copilot Review Runbook" as **mandatory verbatim carries** for derived repos. - Add a canonical **"Files and Sections Derived Repos Must Carry Verbatim"** list and a **"Staying in Sync and Reporting Drift Upstream"** section to `AGENTS.md`; wire the README TODO list and the copilot-instructions "When in Doubt" to them. - Mandate carrying `.editorconfig` **and** `.gitattributes` to stop files drifting between LF and CRLF (a real failure seen across ports). - Add the **upstream-defect-reporting contract**: derived repos that spot a template gap file an issue in `ptr727/ProjectTemplate` rather than only patching locally. ## #111 - brownfield required_signatures migration - Document the procedure (re-sign legacy history, temporarily disable ruleset enforcement to force-push since the admin bypass does **not** cover `git push --force`, re-enable). - Tighten Step 0 to delete **all** legacy protection and name the JSON export/import as the only ruleset-config method. - Cross-link from the `AGENTS.md` branching model. Verified: `markdownlint-cli2 "**/*.md"` reports 0 errors across all 10 files; all touched files retain CRLF endings. Fixes#116Fixes#117Fixes#111
Contributor
There was a problem hiding this comment.
Pull request overview
This PR promotes develop to main while folding in template-level guidance and artifacts intended to be carried verbatim by derived repositories, and rolling up the latest codegen output.
Changes:
- Added an authoritative, shared Markdown lint configuration (
.markdownlint-cli2.jsonc) and documented it as a required verbatim carry for derived repos. - Strengthened and cross-linked the “verbatim carry” contract across
README.md,AGENTS.md, and.github/copilot-instructions.md, including brownfield guidance forrequired_signaturesmigrations and known-working local linter invocations. - Minor hygiene updates: extend
.editorconfigto coverjsonc, quote$GITHUB_OUTPUTin a workflow step, and refresh the codegen timestamp.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Expands derived-repo carry contract and documents brownfield signed-history migration steps in GitHub setup guidance. |
| CODESTYLE.md | Documents .markdownlint-cli2.jsonc as the single source of truth for Markdown lint behavior (IDE + CLI). |
| CodeGen/CodeGen.cs | Updates generated timestamp output (codegen roll-up). |
| AGENTS.md | Makes verbatim-carry requirements explicit, adds known-working local linter Docker invocations, and links brownfield migration guidance. |
| .markdownlint-cli2.jsonc | Adds shared markdownlint configuration aligned between editor extension and CLI. |
| .github/workflows/build-datebadge-task.yml | Quotes $GITHUB_OUTPUT to avoid word-splitting/path issues in the shell redirection target. |
| .github/copilot-instructions.md | Clarifies this runbook is a verbatim carry for derived repos and reinforces upstream issue reporting for template gaps. |
| .editorconfig | Extends JSON EOL rules to apply to *.jsonc as well as *.json. |
Uh oh!
There was an error while loading. Please reload this page.
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 freeto 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.
Promotes
developtomain..markdownlint-cli2.jsonc(Ship a shared .markdownlint-cli2.jsonc so derived repos lint consistently (IDE vs CLI) #116), explicit verbatim-copy contract + line-ending mandate + upstream-defect-reporting contract (Propagate the Copilot review-loop contract + runbook to derived repos #117), brownfieldrequired_signaturesmigration (required_signatures migration: re-signing legacy commits blocked by ruleset (admin bypass not honored for git force-push) #111), and known-working actionlint/markdownlint Docker linter guidance. Review-loop feedback applied (modern re-sign, maintainer-only force-push).