Docs/maintainers and tls#147
Merged
Merged
Conversation
Two CII Best Practices quick wins ahead of the badge submission. 1. MAINTAINERS.md (new) Lists project lead (Albert Mavashev / @amavashev), contributing organizations (Runcycles, K2nio, Singleton Labs, Anthropic), and triage / review / release SLAs. Answers the CII "Roles document" criterion (Basics) which was previously NEEDS DECISION. Also gives external contributors a clear "who do I talk to" entry point and shows up on the GitHub repo About sidebar. 2. README "Production deployment & TLS" section (new) Documents the recommended deployment topology (TLS-terminating reverse proxy → HTTP cycles-server:7878 → password-protected Redis), names common proxy choices (nginx / Caddy / Traefik / ALB), and explains the rationale for terminating TLS at the ingress layer rather than the app. Adds a network-hardening table covering admin server isolation and required production env vars (REDIS_PASSWORD, ADMIN_API_KEY, WEBHOOK_SECRET_ENCRYPTION_KEY). Answers the CII "TLS for in-transit" Security criterion which was previously NEEDS DECISION. More importantly: it's a real question first-time deployers actually have, and now there's a written answer in the README rather than asking on Discord. Skipped from the original quick-win list: - CONTRIBUTING.md per-repo: GitHub auto-defaults to the org-wide CONTRIBUTING.md at runcycles/.github root. No per-repo file needed — visible at /community page already. - spotbugs-maven-plugin: SpotBugs has a high false-positive rate on Spring code and adds an ongoing CI maintenance tax. CodeQL + JaCoCo's 95% coverage gate already cover the Quality answer defensibly.
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
1 participant
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.
Summary
Checklist
AUDIT.mdupdated (if protocol surface changed)README.mdupdated (if public API changed)Test plan