docs: Apache-2.0 licence and public-repository kit - #54
Merged
Merged
Conversation
Prepare the repository for public visibility, following the conventions of ovander/ascenda-backend and ovander/ha-vigie. - LICENSE: Apache-2.0 (the same text as ha-vigie). - CONTRIBUTING.md, SECURITY.md (private vulnerability reporting, scope, supported versions), CLAUDE.md, .github/CODEOWNERS, issue forms (bug, feature, config) and a pull-request template. - README: package reference sections for bff and ailang, which had none, with examples compiled and vetted against the module; package and "which package" table rows; Security and License sections. - Fix the Socrate link in README and docs/CLIENT-INTEGRATION.md, which pointed to a repository that does not exist (now ovander/go-oauth2). - Fix the README contributing rule on cross-package imports to match the code (bff/pep -> socrate, aigateway -> ailang). - Move the internal review documents out of the public tree (kept privately); CHANGELOG still lists the fixes with their finding IDs. No Go code changes. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GKRxaeYxyDhmt42cehLsGA
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.
What and why
This prepares backendkit to be made public. It follows the same kit and conventions as
ascenda-backend,ascenda-frontendandha-vigie.Licence and contributor kit
LICENSE: Apache-2.0, byte-identical to ha-vigie's.CONTRIBUTING.md: setup, design rules, the exact CI checks, the pull-request flow and releases.SECURITY.md: private vulnerability reporting, scope (the Socrate server itself is out of scope and goes to go-oauth2), supported versions, and past reviews.CLAUDE.md: standing instructions in the same shape as ascenda-backend's..github/:CODEOWNERS, issue forms (bug.ymlwith a package dropdown,feature.yml, andconfig.ymllinking to private reporting and go-oauth2) and a pull-request template.README
bffandailanghad no package reference at all. They now have sections, with examples that I compiled and vetted against the module.bffalso gets a "safe by default" table. Every row in that table was checked against the code:gateway.go);SanitizeReturnToturns//host, absolute URLs, backslash and control-character inputs into/. I ran these inputs to confirm.Fixes
README.md:7anddocs/CLIENT-INTEGRATION.md:4pointed togithub.com/ovander/socrate, which does not exist. It now points toovander/go-oauth2.ctxutil/apierrormay be imported across packages, but the code also hasbff/pep→socrateandaigateway→ailang. The rule now matches the code.Removed from the public tree
CTO-ARCHITECTURE-REVIEW.md,FRAMEWORK-EVOLUTION.md,SECURITY-ARCHITECTURE.mdandSECURITY-AUDIT.md. The two audits still carry "open" markers and a status table last updated at v1.9.0, so they shouldn't be published as they are. The files are archived privately.CHANGELOG.mdstill lists the fixes with their finding IDs.How it was tested
go build ./...,go vet ./...andgo test -race -count=1 ./...pass (14 packages). The PR changes no Go code.bffandailangexamples compile and passgo vetagainst this module.## [Unreleased]inCHANGELOG.md.A gitleaks scan of the full history (all branches and tags) found no secrets. It raised 0 findings on backendkit, and 4 false positives across the suite.
Compatibility
SECURITY.mdand the issue config point to it.🤖 Generated with Claude Code
https://claude.ai/code/session_01GKRxaeYxyDhmt42cehLsGA
Generated by Claude Code