chore: add CHANGELOG.md + fill missing BestPractices criteria#48
Merged
chore: add CHANGELOG.md + fill missing BestPractices criteria#48
Conversation
- CHANGELOG.md: pointer to GitHub Releases (auto-generated per-release
notes) plus a summary log. Fixes the `release_notes` Unmet auto-check
on bestpractices.dev which requires a CHANGELOG/NEWS file at repo root.
- .bestpractices.json: add two entries that were missing from the prior
passing-tier pass:
- documentation_interface — points to docs/cli-reference.md,
rest-api.md, mcp-tools.md
- test_continuous_integration — points to .github/workflows/ci.yml
Totals: 78 Met / 10 N/A / 0 Unknown (88 entries).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
bestpractices.dev validator flagged 'URL required, but no URL found' even though the prior justification embedded the link. Some criteria require the justification field to be a bare URL for auto-detection. Co-Authored-By: Claude Opus 4.7 (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.
Summary
Addresses BestPractices.dev criteria that were missing or flagged as auto-check failures on project 12628.
Changes
CHANGELOG.md(new) — points to GitHub Releases (auto-generated per-release notes via `.github/release.yml`) plus a summary log in Keep-a-Changelog format. Fixes the `release_notes` Unmet auto-check on bestpractices.dev which looks for a CHANGELOG/NEWS file at repo root.`.bestpractices.json` — add two entries that were missing from the prior passing-tier pass:
Totals
Side-effect (no code change)
GitHub repo "About" panel also populated via `gh api` PATCH:
Form-field reminder
On the bestpractices.dev form, `vulnerability_report_process` requires a URL in its dedicated URL field (separate from the justification). Paste:
`https://github.com/RandomCodeSpace/docsiq/blob/main/SECURITY.md\`
Test plan
🤖 Generated with Claude Code