Skip to content

docs: add badge row, CodeQL, Scorecard, CITATION.cff and llms.txt - #11

Merged
ryanduguid merged 1 commit into
mainfrom
ryan/badges-geo
Oct 29, 2026
Merged

ryanduguid merged 1 commit into
mainfrom
ryan/badges-geo

Conversation

@ryanduguid

@ryanduguid ryanduguid commented Oct 29, 2026 •

Copy link
Copy Markdown
Collaborator

Brings this README's badge row into line with the other repositories of this maintainer, and adds machine-readable project metadata.

Changes

  • Badge row (new): tests and CodeQL; OpenSSF Scorecard; Rust 1.99+ and licence.
  • New codeql.yml (JavaScript/TypeScript, Rust, Actions) and scorecard.yml workflows.
  • CITATION.cff (references Oracle by Peter Steinberger) and llms.txt.

Verification

cargo test --locked --test docs_contracts (5 passed); alcuin docs check --docs-path README.md; actionlint 1.7.12; cffconvert --validate; every llms.txt link resolves.

The CodeQL badge reads 'not found' until this workflow first runs on main after merge. The Scorecard badge reads 'invalid repo path' until scorecard.yml is first dispatched on main.

@github-advanced-security

github-advanced-security AI commented Oct 29, 2026 •

Copy link
Copy Markdown

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

  • The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
  • Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
  • You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

@sonarqubecloud

sonarqubecloud Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

@ryanduguid
ryanduguid merged commit 687a9ff into main Oct 29, 2026
11 checks passed
@ryanduguid
ryanduguid deleted the ryan/badges-geo branch October 29, 2026 23:26
EquityBot pushed a commit that referenced this pull request Nov 1, 2026
Co-authored-by: Ryan Duguid <ryanduguid@users.noreply.github.com>
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.

2 participants