chore: add OSS community-health scaffold and badges#14
Conversation
- LICENSE (MIT, Copyright (c) 2026 pleaseai)
- CONTRIBUTING.md (bun-based local setup)
- CODE_OF_CONDUCT.md (Contributor Covenant 2.1, conduct@pleaseai.dev)
- SECURITY.md (private reporting, security@pleaseai.dev)
- .github/PULL_REQUEST_TEMPLATE.md
- .github/ISSUE_TEMPLATE/{bug_report,feature_request,config}
- orca.yaml + .worktreeinclude (bun-only worktree setup)
- README: add License MIT badge
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThis PR adds repository governance and community files: GitHub issue and PR templates, CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md, an MIT LICENSE, a README license badge, and worktree automation files for new git worktrees. ChangesCommunity docs and repo templates
Estimated code review effort: 1 (Trivial) | ~5 minutes Related Issues: None specified Related PRs: None specified Suggested labels: documentation, chore Suggested reviewers: None specified Poem: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request establishes the repository's community, contribution, and development tooling foundation. It adds issue and pull request templates, a Code of Conduct, contributing guidelines, an MIT license, a security policy, and worktree setup configurations (.worktreeinclude and orca.yaml) for automated development environments. There are no review comments, and I have no feedback to provide.
Greptile SummaryThis PR adds the standard OSS community-health scaffold — MIT LICENSE, CONTRIBUTING.md, CODE_OF_CONDUCT.md (Contributor Covenant 2.1), SECURITY.md, GitHub issue/PR templates, and a License badge in the README — along with
Confidence Score: 5/5Safe to merge — all changes are documentation and dev-tooling scaffolding with no impact on the published package. Every changed file is a community health document, GitHub template, or worktree-setup config; none of them affect the built library or CI pipeline. The two minor issues found (missing set -u in the Orca setup script and an omitted type-check step in the PR template) are quality-of-life improvements for contributors and have no runtime consequences. No files require special attention; orca.yaml and .worktreeinclude have small hardening suggestions but are not blocking. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Orca creates new worktree] --> B["orca.yaml scripts.setup runs"]
B --> C["set -eu"]
C --> D["bunx @pleaseai/worktreeinclude\n$ORCA_ROOT_PATH → $ORCA_WORKTREE_PATH"]
D --> E{".worktreeinclude patterns\nAND git-ignored?"}
E -->|Yes| F["Copy .env / .env.local\n.env.*.local files"]
E -->|".claude/settings.local.json\n(only if .git/info/exclude set)"| G["Copy .claude/settings.local.json\n⚠ machine-dependent"]
F --> H["bun install --frozen-lockfile"]
G --> H
H --> I[Worktree ready]
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
A[Orca creates new worktree] --> B["orca.yaml scripts.setup runs"]
B --> C["set -eu"]
C --> D["bunx @pleaseai/worktreeinclude\n$ORCA_ROOT_PATH → $ORCA_WORKTREE_PATH"]
D --> E{".worktreeinclude patterns\nAND git-ignored?"}
E -->|Yes| F["Copy .env / .env.local\n.env.*.local files"]
E -->|".claude/settings.local.json\n(only if .git/info/exclude set)"| G["Copy .claude/settings.local.json\n⚠ machine-dependent"]
F --> H["bun install --frozen-lockfile"]
G --> H
H --> I[Worktree ready]
Reviews (2): Last reviewed commit: "chore: apply AI code review suggestions" | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@orca.yaml`:
- Line 16: The worktree setup command in the Orca bootstrap config uses an
unpublished package, so it will fail at runtime. Replace the bunx invocation of
`@pleaseai/worktreeinclude` in the orca.yaml setup step with the correct available
tool or script, keeping the same ORCA_ROOT_PATH and ORCA_WORKTREE_PATH arguments
so the worktree creation flow still works.
In `@SECURITY.md`:
- Around line 5-12: The supported-version policy in SECURITY.md is ambiguous
because the prose suggests older versions may still get fixes while the table
marks them unsupported. Update the wording in the security policy text and the
supported matrix so they consistently state that only the latest released major
version is in scope for security fixes, and older versions are not supported
except at maintainers’ discretion if you want that exception explicitly called
out.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: f8d65335-bd48-441c-b5bf-9c3375d1b509
📒 Files selected for processing (11)
.github/ISSUE_TEMPLATE/bug_report.md.github/ISSUE_TEMPLATE/config.yml.github/ISSUE_TEMPLATE/feature_request.md.github/PULL_REQUEST_TEMPLATE.md.worktreeincludeCODE_OF_CONDUCT.mdCONTRIBUTING.mdLICENSEREADME.mdSECURITY.mdorca.yaml
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
1 issue found across 11 files
Architecture diagram
sequenceDiagram
participant Dev as Developer
participant Repo as GitHub Repository
participant GH as GitHub Issues/PRs
participant CI as CI Pipeline
participant Local as Local Env (Bun Worktree)
Note over Dev,Local: NEW: OSS Community-Health Scaffold & Worktree Setup
Dev->>Repo: Clone repo & checkout branch
Repo->>Local: Read orca.yaml + .worktreeinclude
Local->>Local: Run bunx @pleaseai/worktreeinclude
Local->>Local: Copy .env, .env.*.local, settings.local.json
Local->>Local: Run bun install --frozen-lockfile
Dev->>Local: Run bun run lint / bun test / bun run type-check / bun run build
Local-->>Dev: Lint/test/type-check/build results
Dev->>GH: Open PR (uses PULL_REQUEST_TEMPLATE)
GH->>Repo: Validate PR title follows Conventional Commits
opt PR checklist
GH->>GH: Check tests pass, lint passes, docs updated
end
alt Bug report
Dev->>GH: Submit bug_report.md (with steps, env, logs)
GH->>Repo: Labels issue "bug"
else Feature request
Dev->>GH: Submit feature_request.md (with problem, solution, alternatives)
GH->>Repo: Labels issue "enhancement"
else Security report
Dev->>Repo: Use SECURITY.md private channel (security@pleaseai.dev)
Repo->>Repo: Notify maintainers (within 72h)
end
Note over Dev,CI: NEW: Contribution lifecycle with conduct/code expectations
Dev->>Repo: Submit contribution
Repo->>GH: Enforce CODE_OF_CONDUCT.md (conduct@pleaseai.dev)
alt Violation detected
GH->>Repo: Community leader review
Repo->>Dev: Warning / temporary ban / permanent ban
end
Repo->>CI: Trigger CI on PR
CI->>CI: Run tests (bun test), lint (bun run lint), type-check, build
CI-->>Dev: CI results (green/red)
Dev-->>Repo: Merge PR (squash commit with Conventional Commits title)
Note over Repo: README displays License: MIT badge (via shields.io)
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
|
1 participant
Summary
Adds the OSS community-health scaffold and standard badges for
@pleaseai/cli-toolkit.Copyright (c) 2026 Passion Factory(consistent withpackage.json"license": "MIT").bun install,bun run lint,bun test,bun run type-check,bun run build); Conventional Commits guidance.bunx @pleaseai/worktreeincludethenbun install --frozen-lockfile.License: MITbadge.Notes
badge.fury.io), so only the License badge was added — no duplicate npm badge.codecov.ymlandsonar-project.propertieswere left untouched.Summary by cubic
Adds OSS community-health files and a MIT License badge for
@pleaseai/cli-toolkit, plus a Bun-only worktree setup for consistent local development.LICENSE, Contributor Covenant 2.1 (conduct@pleaseai.dev),SECURITY.mdwith private reporting (security@pleaseai.dev), andCONTRIBUTING.md(Bun workflow + Conventional Commits). Adds a License badge to the README.orca.yamland.worktreeincludeto bootstrap worktrees withbunx @pleaseai/worktreeincludeandbun install --frozen-lockfile.Written for commit 5b7db67. Summary will update on new commits.
Summary by CodeRabbit