Skip to content

chore: add CHANGELOG.md + fill missing BestPractices criteria#48

Merged
aksOps merged 2 commits intomainfrom
bp-fixup-missing-criteria
Apr 23, 2026
Merged

chore: add CHANGELOG.md + fill missing BestPractices criteria#48
aksOps merged 2 commits intomainfrom
bp-fixup-missing-criteria

Conversation

@aksOps
Copy link
Copy Markdown
Contributor

@aksOps aksOps commented Apr 23, 2026

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:

    • `documentation_interface` → Met (docs/cli-reference.md, rest-api.md, mcp-tools.md)
    • `test_continuous_integration` → Met (.github/workflows/ci.yml)

Totals

  • Before: 76 Met / 10 N/A / 0 Unknown (86 entries)
  • After: 78 Met / 10 N/A / 0 Unknown (88 entries)

Side-effect (no code change)

GitHub repo "About" panel also populated via `gh api` PATCH:

  • Description: "GraphRAG-powered local documentation search — entity extraction, vector + graph retrieval, MCP server. Written in Go."
  • Homepage: repo URL
  • Topics: graphrag, rag, retrieval-augmented-generation, knowledge-graph, vector-search, mcp-server, documentation-search, go, sqlite, langchaingo

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

  • CI passes
  • `.bestpractices.json` remains valid JSON (verified locally: 78/10/0)
  • CHANGELOG.md renders on GitHub repo root
  • Next BestPractices scan picks up CHANGELOG.md and flips `release_notes` to Met

🤖 Generated with Claude Code

aksOps and others added 2 commits April 23, 2026 06:35
- 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>
@aksOps aksOps merged commit 72c64e8 into main Apr 23, 2026
12 checks passed
@aksOps aksOps deleted the bp-fixup-missing-criteria branch April 23, 2026 06:49
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