Skip to content

docs: track CHANGELOG.md (allowlist in .gitignore)#6

Merged
vedantggwp merged 1 commit into
masterfrom
cc/changelog-allowlist
Jun 13, 2026
Merged

docs: track CHANGELOG.md (allowlist in .gitignore)#6
vedantggwp merged 1 commit into
masterfrom
cc/changelog-allowlist

Conversation

@vedantggwp

Copy link
Copy Markdown
Owner

Follow-up to #5: the repo's allowlist .gitignore was ignoring CHANGELOG.md, so the README/MANIFEST links pointed at an untracked file. Allowlist it and commit it.

The repo uses an allowlist .gitignore (`*` then `!path`). CHANGELOG.md was not
allowlisted, so PR #5 merged the README/MANIFEST links to it without the file
itself. Allowlist it and commit the changelog so the link isn't dangling.
@vedantggwp vedantggwp merged commit c6f448d into master Jun 13, 2026
3 checks passed
@devin-ai-integration

Copy link
Copy Markdown

Code Review — PR #6

Overall: Clean fix ✓ — this correctly unblocks CHANGELOG.md from the allowlist .gitignore so the file is tracked.

Minor observations

  1. Gitignore ordering: The allowlist comment now says # Allow top-level MANIFEST + README + CHANGELOG but the entries are MANIFEST.md, README.md, CHANGELOG.md. Consider keeping them alphabetical (CHANGELOG.md first) or alphabetising the comment — trivial, but as the list grows it'll matter.

  2. No test for .gitignore coverage: If more top-level .md files are added in the future (e.g., CONTRIBUTING.md), they'll silently be ignored. A CI step or a pre-commit hook that warns when tracked-looking files are gitignored could prevent this class of bug from recurring.

No bugs or edge cases — this PR is solid.

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