Add community health files (CoC, contributing, security) - #85
Merged
Conversation
SECURITY, CONTRIBUTING, and CODE_OF_CONDUCT close the remaining GitHub community-profile gaps for sponsors and OSS program review. Discussions is enabled so the existing issue-template contact link works.
There was a problem hiding this comment.
No issues found across 4 files
Confidence score: 5/5
- Automated review surfaced no issues in the provided summaries.
- No files require special attention.
Architecture diagram
sequenceDiagram
participant User as Open Source Contributor
participant GitHub as GitHub Platform
participant Repo as Sploosh Repository
participant CoC as CODE_OF_CONDUCT.md
participant Contrib as CONTRIBUTING.md
participant Security as SECURITY.md
participant README as README.md
participant Discuss as GitHub Discussions
participant AGENTS as AGENTS.md
participant Vision as VISION.md
participant Spec as LANGUAGE_SPEC.md
Note over User,Discuss: Community Health Files — Runtime Interactions
User->>GitHub: Navigate to repository
GitHub->>Repo: Check community profile
alt CoC detected
GitHub->>CoC: Read CODE_OF_CONDUCT.md
CoC-->>GitHub: Contributor Covenant 2.1
else Contributing detected
GitHub->>Contrib: Read CONTRIBUTING.md
Contrib->>AGENTS: Refer to AGENTS.md
Contrib->>Vision: Refer to VISION.md
Contrib->>Spec: Refer to LANGUAGE_SPEC.md
Contrib-->>GitHub: Setup, PR process, definition of done
else Security detected
GitHub->>Security: Read SECURITY.md
Security-->>GitHub: Private reporting, pre-1.0 scope, email contact
end
User->>GitHub: Visit README.md
README->>Contrib: Link to CONTRIBUTING.md
README->>CoC: Link to CODE_OF_CONDUCT.md
README->>Security: Link to SECURITY.md
README->>Discuss: Link to GitHub Discussions
README-->>User: Full contributing section
User->>Discuss: Open new discussion
Discuss->>Discuss: Community Q&A enabled
Discuss-->>User: Discussion thread
User->>GitHub: Open new issue
GitHub->>Repo: Use issue templates
alt Bug report
Repo->>Security: Check if vulnerability
opt Security issue
User->>Security: Follow SECURITY.md reporting
Security-->>User: Private email: revenantpulse@gmail.com
end
end
User->>Contrib: Read contributing guidelines
Contrib->>Contrib: Branch naming, PR process, rebase policy
Contrib-->>User: Development setup instructions
alt Vulnerability reported via email
User->>Security: Email security report
Security->>Security: Acknowledge within 72 hours
Security-->>User: Coordination and fix timeline
end
Requires human review: Docs-only change, but SECURITY.md sets vulnerability-handling/disclosure policy and legal commitments (timelines, no legal action), and CoC names an enforcement contact; these community/security policy choices need human sign-off.
Re-trigger cubic
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.
Summary
CODE_OF_CONDUCT.md(Contributor Covenant 2.1)CONTRIBUTING.md(setup, PR process, definition of done; points at AGENTS.md)SECURITY.md(private reporting, pre-1.0/on-chain scope, no bounty yet).github/ISSUE_TEMPLATE/config.ymlcontact link is liveRelated Issue
N/A — sponsorship / OSS-program readiness hygiene
Spec Sections Affected
None
Checklist
docs/pagesBuild Targets Tested
Test Plan
/discussionsloadsSummary by cubic
Add community health files to set clear contributor guidelines and security reporting, and link them from the README. Enable GitHub Discussions for questions and community support.
CODE_OF_CONDUCT.md(Contributor Covenant 2.1).CONTRIBUTING.md(setup, PR process, definition of done; points toAGENTS.md).SECURITY.md(private reporting, pre-1.0/on-chain scope, no bounty yet).README.mdto link the above and Discussions.Written for commit 20260f9. Summary will update on new commits.