Skip to content

chore: add LICENSE, CONTRIBUTING, coverage badge, and repo topics#86

Merged
laplaque merged 1 commit intomainfrom
chore/community-readiness
Mar 30, 2026
Merged

chore: add LICENSE, CONTRIBUTING, coverage badge, and repo topics#86
laplaque merged 1 commit intomainfrom
chore/community-readiness

Conversation

@laplaque
Copy link
Copy Markdown
Owner

Summary

Community readiness improvements — adds the practical signals that indicate a healthy open-source project.

Changes

  • LICENSE — MIT
  • CONTRIBUTING.md — points to docs/development.md for workflow, covers fork/branch/PR conventions, pack contribution guidance, and issue reporting
  • Coverage badge — shields.io endpoint badge via the same gist used for benchmark badges. CI test job updates the gist on push to main. Thresholds: green ≥85%, yellow ≥70%, red <70%
  • License badge — static MIT badge in README
  • Repo topicsprivacy, proxy, pii, gdpr, golang, llm, anonymization, mitm-proxy, ai-security, self-hosted

Notes

  • Topics are already applied (they're a repo setting, not a file)
  • Coverage badge will show "not found" until the first push to main populates the gist with coverage.json
  • Reuses BENCHMARK_GIST_TOKEN secret — no new secrets needed

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 30, 2026

Benchmark results

Benchmark ns/op Budget Headroom Status
BenchmarkRegexPassEmail 1.8µs 2.5ms 99% ✅ PASS
BenchmarkRegexPassMultiple 2.7µs 2.5ms 99% ✅ PASS

Budget: regex/cache < 2.5ms (0.5% of 500ms baseline), streaming < 20ms (4% of 500ms baseline)

- MIT license
- CONTRIBUTING.md pointing to docs/development.md
- Coverage badge via shields.io endpoint (same gist as benchmarks)
- CI step to update coverage badge on push to main
- License badge in README
- Repo topics: privacy, proxy, pii, gdpr, golang, llm, anonymization,
  mitm-proxy, ai-security, self-hosted
@laplaque laplaque force-pushed the chore/community-readiness branch from 98e6b33 to 353c840 Compare March 30, 2026 21:34
@laplaque laplaque merged commit f62fe69 into main Mar 30, 2026
8 checks passed
@laplaque laplaque deleted the chore/community-readiness branch March 30, 2026 21:37
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