docs: add org community health defaults - #2
Merged
Merged
Conversation
Mirror Rethunk-AI organization defaults (SECURITY, SUPPORT, CONTRIBUTING, CODE_OF_CONDUCT) adapted for Rethunk-Tech contacts and CLIs/hooks/CI scope. Co-authored-by: Damon Blais <damon@rethunk.tech>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
🔵 Needs a closer look
Organization-default links and branch references need correction before approval.
Pull request overview
Adds organization-default GitHub community health files for repositories without local versions.
Changes:
- Added security, support, contribution, and conduct policies.
- Linked the community health files from
README.md. - Added repository and archived-project guidance.
File summaries
| File | Description |
|---|---|
SUPPORT.md |
Support channels and issue guidance |
SECURITY.md |
Default vulnerability reporting policy |
README.md |
Links to community health files |
CONTRIBUTING.md |
Contribution and PR expectations |
CODE_OF_CONDUCT.md |
Contributor Covenant policy |
Review details
Suppressed comments (6)
CONTRIBUTING.md:9
- When this organization-default file is inherited, GitHub resolves this relative link against
Rethunk-Tech/.github, not the consuming repository. A repository with its ownCODE_OF_CONDUCT.mdis therefore still sent to the organization default, despite the override guidance above. Use explicit repository-local guidance with an absolute fallback to the organization policy.
- Be respectful — see [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md).
CONTRIBUTING.md:34
- When this organization-default file is inherited, this relative link resolves to
Rethunk-Tech/.github/SECURITY.md, not the affected repository's policy. That can route a vulnerability report using the generic policy even when the repository defines different reporting instructions. Please state the repository-specific fallback explicitly and link the organization default with an absolute URL.
Report vulnerabilities privately — see [`SECURITY.md`](SECURITY.md).
CONTRIBUTING.md:27
- This organization-wide fallback is consumed by repositories whose default branch may not be
main; the parenthetical makes the generic contribution instruction inaccurate for those repositories. Refer only to the repository's default branch and leave any branch naming to repo-specific docs.
1. Branch from the repository default branch (`main` unless noted).
SECURITY.md:16
- The
<repo>placeholder is never substituted in an organization-default file, so copying this URL sends reporters to a literal, nonexistent repository path. Since this policy promises a GitHub advisory route, direct readers to the affected repository's Security tab instead of publishing a non-functional URL.
`https://github.com/Rethunk-Tech/<repo>/security/advisories/new`
SECURITY.md:9
- Because this is the organization-wide fallback, a consuming repository may use a default branch other than
main; this text would then incorrectly tell reporters that onlymainis supported and that security fixes land there. Refer to the affected repository's default branch without hardcodingmain.
Unless a repo says otherwise, only the default branch (`main`) is supported.
Security fixes land there; there is typically no long-lived release branch.
SUPPORT.md:11
- When this organization-default file is inherited, this relative link resolves to the organization repository's
SECURITY.md, not a repository-specificSECURITY.md. A repo with its own disclosure channel can therefore be directed to the wrong instructions. Replace the relative link with explicit repository-local guidance and an absolute organization-default fallback.
| Security vulnerability | See [`SECURITY.md`](SECURITY.md) — do **not** file a public issue |
- Files reviewed: 5/5 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This branch was successfully deployed
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
Adds organization-default community health files so repos without their own still show a complete Community health panel. Adapted from the live set on Rethunk-AI/.github (PR #2).
SECURITY.md— private disclosure via GitHub advisories oross@rethunk.tech; scope framed for CLIs, hooks, and CI ActionsSUPPORT.md— issues / we.rethunk.tech / OSS email; archived repos point at the org profile Archived section (no Discord row)CONTRIBUTING.md— Conventional Commits + PR expectations (defers to repo-specific docs)CODE_OF_CONDUCT.md— Contributor Covenant 2.1; enforcement viaoss@rethunk.techREADME.md— one Documentation-table row pointing at the four files (profile/README.mdunchanged)No invented contacts or projects. Repo-level files still win when present.
Test plan
SECURITY.md(after merge) for inherited Community health linksoss@rethunk.ai/ Discord / "Prior art" leftovers in this PR