Skip to content

Downstream repos leak the private template repo, plus two prose/comment style-rule proposals #357

Description

@ptr727

Filed from a derived repo per the drift-reporting responsibility. Two independent items.

1. Drift: downstream files name and link the private template repo

Template-injected content in derived repos references the private template repo by name and link. That is a dead link for public readers, since they cannot open a private repo, and it leaks the coordinator's existence. Found in a derived repo:

  • .github/copilot-instructions.md, the "When in Doubt" drift-reporting paragraph, named and linked the private repo and an AGENTS.md anchor in it.
  • CODESTYLE.md, the spell-check-scope item, said "the template ships README + HISTORY as the default".

Suggest genericizing downstream-facing text so the private hub stays opaque. For example, route drift-reporting through "raise it with the maintainer" without naming or linking the private repo, and phrase defaults without attributing them to "the template". The agent-facing responsibility to report drift upstream can live in agent session memory rather than a public repo file.

I have scrubbed both locally in the derived repo, but the durable fix belongs here so it does not return on reconvergence.

2. Proposal: two general prose and comment style rules

These surfaced while the maintainer reviewed agent-authored text. Both are general, applying to any repo or language, so I am proposing them for the shared conventions rather than as a per-repo divergence.

  • No class- or file-header summary comment blocks. A type gets a comment only for a specific non-obvious point, kept terse. This complements the existing "no design narrative" and one-line-comment rules.
  • No semicolons as sentence separators in agent-authored prose (comments, docs, PR and commit text). Recast as a comma or as two sentences, the same house style as the existing em-dash ASCII ban. This is a prose rule only. Code statement terminators are unaffected.

Deferring on whether to adopt these, where they should live (AGENTS.md Comments and Character Set, or CODESTYLE.md), and how downstream repos apply them.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions