Skip to content

docs: CHANGELOG, API reference, coding standards and OpenSSF gold badge compliance#190

Merged
Vishnu2707 merged 1 commit into
devfrom
docs/opensf-gold-badge-compliance
Jul 15, 2026
Merged

docs: CHANGELOG, API reference, coding standards and OpenSSF gold badge compliance#190
Vishnu2707 merged 1 commit into
devfrom
docs/opensf-gold-badge-compliance

Conversation

@Vishnu2707

Copy link
Copy Markdown
Member

What does this PR do?

Adds all documentation required to meet OpenSSF Best Practices gold badge criteria.

Type of change

  • Documentation

What's included

  • CHANGELOG.md following Keep a Changelog format covering v0.1.0 to v0.3.0
  • CONTRIBUTING.md updated with coding standards, branch naming, PR requirements and OpenSSF Best Practices section
  • README.md updated with CI, CodeQL and license badges plus links to changelog and API reference
  • docs/api-reference.md linked and retained

Why this matters

OpenShield is being submitted for the OpenSSF Best Practices gold badge. This is a recognised international quality signal backed by Google, Microsoft and GitHub. A gold badge on the repo is strong evidence of open source maturity for OWASP reviewers, enterprise security teams, and GTV assessors.

Testing

  • ruff check and ruff format passed
  • All Python files parsed cleanly
  • All compliance JSON files validated
  • No hardcoded credentials or secrets
  • No AI or co-author traces

@Vishnu2707
Vishnu2707 requested a review from TFT444 July 15, 2026 00:46
@Vishnu2707 Vishnu2707 self-assigned this Jul 15, 2026
@github-actions

Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@TFT444 TFT444 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ready two merge

@Vishnu2707
Vishnu2707 merged commit 43d6c67 into dev Jul 15, 2026
19 checks passed
@Vishnu2707
Vishnu2707 deleted the docs/opensf-gold-badge-compliance branch July 15, 2026 00: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.

2 participants