Skip to content

chore: untrack maintainer-internal docs (DECISIONS.md, CE compat evidence) - #34

Merged
PF9-pushkar merged 1 commit into
mainfrom
chore/untrack-maintainer-docs
Jul 14, 2026
Merged

chore: untrack maintainer-internal docs (DECISIONS.md, CE compat evidence)#34
PF9-pushkar merged 1 commit into
mainfrom
chore/untrack-maintainer-docs

Conversation

@PF9-pushkar

Copy link
Copy Markdown
Collaborator

Prep for the public repo: DECISIONS.md (internal design/deviation log) and docs/compatibility/ce-2026.4.md (CE preflight compatibility evidence) are maintainer notes, not appropriate for a public repository.

  • Add both to .gitignore and git rm --cached them — they stay on the maintainer's disk, out of the tree going forward.
  • Scrub the four see DECISIONS.md / compatibility-file references from tracked files (2 in CHANGELOG, 2 code comments) so the public repo has no dangling links.

README.md, CHANGELOG.md, and RELEASING.md remain tracked as public docs. No functional change; build/vet/gofmt/lint clean.

Note: this only stops tracking the files going forward — the repo is still private, so a git-history scrub (if ever wanted) is a separate step.

DECISIONS.md (internal design/deviation log) and docs/compatibility/ce-2026.4.md
(CE preflight compatibility evidence) are maintainer notes, not appropriate for
a public repository. Add both to .gitignore and remove them from tracking (they
remain on the maintainer's disk). Also scrub the few "see DECISIONS.md" /
compatibility-file references from tracked files (CHANGELOG and two code
comments) so the public repo has no dangling links.

README.md, CHANGELOG.md, and RELEASING.md stay tracked as public docs.
@PF9-pushkar
PF9-pushkar merged commit d5dcfb6 into main Jul 14, 2026
5 checks passed
@PF9-pushkar
PF9-pushkar deleted the chore/untrack-maintainer-docs branch July 14, 2026 01:49
PF9-pushkar added a commit that referenced this pull request Jul 14, 2026
chore: untrack maintainer-internal docs (DECISIONS.md, CE compat evidence)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant