Skip to content

docs: improve README, CONTRIBUTING, and SECURITY#349

Merged
bartekplus merged 2 commits intomasterfrom
docs/improve-readme-contributing-security
Mar 24, 2026
Merged

docs: improve README, CONTRIBUTING, and SECURITY#349
bartekplus merged 2 commits intomasterfrom
docs/improve-readme-contributing-security

Conversation

@bartekplus
Copy link
Copy Markdown
Owner

Summary

  • README.md: Added CodeQL badge, expanded Development Setup into structured subsections, added Architecture section with directory tree, added License footer
  • CONTRIBUTING.md: Added architecture layer rules table, entry points table, import conventions, testing policy with regression/coverage details, runtime feature workflows (prediction, settings, variables, logging), language asset rebuild and versioning sections
  • SECURITY.md: Added supported versions table, privacy model section documenting security-relevant design, vulnerability scope definition

Test plan

  • Verify all markdown renders correctly on GitHub
  • Confirm all links resolve (badges, issue templates, doc cross-references)
  • No functional code changes — documentation only

🤖 Generated with Claude Code

bartekplus and others added 2 commits March 24, 2026 07:46
- README: add CodeQL badge, Architecture section with directory tree,
  expand Development Setup into subsections (install, quality checks,
  testing, watch mode), add License footer
- CONTRIBUTING: add architecture layer rules table, entry points table,
  import conventions, testing policy with regression/coverage details,
  runtime feature workflows (prediction, settings, variables, logging),
  language asset rebuild and versioning sections
- SECURITY: add supported versions table, privacy model section,
  vulnerability scope definition

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@bartekplus bartekplus merged commit a70f10d into master Mar 24, 2026
8 checks passed
@bartekplus bartekplus deleted the docs/improve-readme-contributing-security branch March 24, 2026 06:53
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