Skip to content

chore: add Apache-2.0 LICENSE and community-health files#16

Merged
amondnet merged 4 commits into
mainfrom
chore/oss-community-health
Jul 14, 2026
Merged

chore: add Apache-2.0 LICENSE and community-health files#16
amondnet merged 4 commits into
mainfrom
chore/oss-community-health

Conversation

@amondnet

@amondnet amondnet commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds the open-source community-health files this repo was missing and formalizes the license (which was already declared Apache-2.0 in all 8 packages and the README, but had no root LICENSE file or root license field).

  • LICENSE: canonical Apache-2.0 full text, appendix copyright Copyright 2026 Passion Factory.
  • NOTICE: preserves attribution to the Apache-2.0 upstream vercel-labs/emulate (Chris Tate), which this project is derived from.
  • package.json: added "license": "Apache-2.0" to the root manifest (sub-packages already declared it).
  • CONTRIBUTING.md: adapted to the real mise + bun + turbo toolchain (mise install, bun install, mise run ci), Conventional Commits + release-please note, "adding a new service" pointer.
  • CODE_OF_CONDUCT.md: Contributor Covenant 2.1, contact conduct@pleaseai.dev.
  • SECURITY.md: private vulnerability reporting, contact security@pleaseai.dev.
  • .github/: PR template + issue templates (bug_report, feature_request, config.yml).
  • README.md: added npm version badge (@pleaseai/emulate) and Apache-2.0 license badge to the existing badge row.

Note: the original scaffold brief said MIT; corrected to Apache-2.0 to match the 8 package manifests, the README, and the Apache-2.0 upstream. Confirmed with the requester.

Related issue

Checklist

  • PR title follows Conventional Commits
  • No breaking change
  • Docs/community-health files only — no code behavior change

Summary by cubic

Formalizes Apache-2.0 licensing and adds standard OSS community-health files. Restores the root LICENSE to the canonical Apache-2.0 text (verbatim, with appendix copyright).

Adds root NOTICE, CODE_OF_CONDUCT.md, SECURITY.md, CONTRIBUTING.md, and GitHub issue/PR templates (disable blank issues; add Discussions/security links); sets root package.json "license": "Apache-2.0" and sorts it after "packageManager" to satisfy @pleaseai/eslint-config sort-keys; adds npm/license badges to README.md (@pleaseai/emulate); no runtime code changes.

Written for commit 1c9fa42. Summary will update on new commits.

Summary by CodeRabbit

  • New Features
    • Added GitHub issue templates for bug reports and feature requests.
    • Added a pull request template with guidance and a checklist.
  • Bug Fixes
    • Improved issue submission by disabling blank issues and routing general and security inquiries to the appropriate channels.
  • Documentation
    • Added/updated repository policy documents (Code of Conduct, contributing guide, security policy).
    • Added license and notice documentation; updated README with an NPM version badge.

@coderabbitai

coderabbitai Bot commented Jul 1, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Adds GitHub community health files, licensing metadata, and an npm badge update for the repository.

Changes

Repository Community Files

Layer / File(s) Summary
Issue and PR templates
.github/ISSUE_TEMPLATE/bug_report.md, .github/ISSUE_TEMPLATE/feature_request.md, .github/ISSUE_TEMPLATE/config.yml, .github/PULL_REQUEST_TEMPLATE.md
Adds bug report and feature request issue templates, issue config with contact links to Discussions and Security Advisories, and a PR template.
Contribution and conduct guidelines
CONTRIBUTING.md, CODE_OF_CONDUCT.md
Adds a contribution guide covering workflow, commit conventions, and adding services, plus the Contributor Covenant Code of Conduct.
Security policy
SECURITY.md
Adds supported-version info, private vulnerability reporting instructions, and response expectations.
Licensing files and metadata
LICENSE, NOTICE, package.json
Adds the Apache 2.0 license text, project attribution NOTICE, and sets license: Apache-2.0 in package.json.
README badge update
README.md
Adds an npm version badge linking to the package page.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the main change: adding Apache-2.0 licensing and community-health files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/oss-community-health

Comment @coderabbitai help to get the list of available commands.

@codacy-production

Copy link
Copy Markdown

Not up to standards ⛔

🔴 Issues 1 high

Alerts:
⚠ 1 issue (≤ 0 issues of at least minor severity)

Results:
1 new issue

Category Results
Security 1 high

View in Codacy

🟢 Metrics 0 complexity · 0 duplication

Metric Results
Complexity 0
Duplication 0

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@greptile-apps

greptile-apps Bot commented Jul 1, 2026

Copy link
Copy Markdown

Greptile Summary

This PR formalizes the Apache-2.0 license that was already declared in all 8 sub-packages and the README by adding a root LICENSE file, a NOTICE with proper upstream attribution, and the full suite of OSS community-health files. No runtime code is changed.

  • License & attribution: Adds canonical Apache-2.0 LICENSE (copyright 2026 Passion Factory) and a NOTICE attributing the upstream vercel-labs/emulate project (Chris Tate, 2025), satisfying Apache-2.0 Section 4(d) redistribution requirements; root package.json "license" field is aligned to match sub-packages.
  • Community-health files: CONTRIBUTING.md is accurately tailored to the real mise+bun+turbo toolchain (all referenced files and mise run ci task verified to exist); SECURITY.md, CODE_OF_CONDUCT.md, and GitHub issue/PR templates are standard and well-formed.
  • README badges: npm version and Apache-2.0 license badges are added to the existing badge row, both pointing to correct targets.

Confidence Score: 5/5

Documentation and community-health files only — no runtime code changes; safe to merge.

All changed files are documentation, license text, and GitHub community-health metadata. All internal cross-references (docs/EMULATOR-CONVENTIONS.md, packages/emulate/src/registry.ts, mise run ci task) were verified to exist in the repository. The Apache-2.0 license text is canonical, the NOTICE correctly attributes the upstream project, and the package.json license field aligns with the 8 sub-packages that already declared it.

No files require special attention.

Important Files Changed

Filename Overview
LICENSE Adds canonical Apache-2.0 full text with copyright "Copyright 2026 Passion Factory"; formalizes the license that was already declared in all sub-packages.
NOTICE Adds required Apache-2.0 attribution notice crediting upstream vercel-labs/emulate (Chris Tate, Copyright 2025); satisfies Section 4(d) of the Apache-2.0 license.
CONTRIBUTING.md New contributor guide tailored to the actual mise+bun+turbo toolchain; all referenced files (docs/EMULATOR-CONVENTIONS.md, packages/emulate/src/registry.ts) and commands (mise run ci) verified to exist.
SECURITY.md Security policy directing reporters to GitHub private vulnerability reporting and security@pleaseai.dev; covers supported versions and response SLA.
CODE_OF_CONDUCT.md Adds standard Contributor Covenant 2.1; contact email conduct@pleaseai.dev; no issues.
.github/ISSUE_TEMPLATE/config.yml Disables blank issues and adds contact links for discussions and private security reporting; standard GitHub issue template config.
package.json Adds "license": "Apache-2.0" to the root manifest after "packageManager"; aligns root with all 8 sub-packages that already declared this license.
README.md Adds npm version badge (links to @pleaseai/emulate) and Apache-2.0 license badge (links to ./LICENSE) to the existing badge row.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    subgraph Root["Repository Root (new files)"]
        LICENSE["LICENSE\nApache-2.0 full text\nCopyright 2026 Passion Factory"]
        NOTICE["NOTICE\nAttribution to vercel-labs/emulate\nChris Tate, Copyright 2025"]
        COC["CODE_OF_CONDUCT.md\nContributor Covenant 2.1\nconduct@pleaseai.dev"]
        CONTRIB["CONTRIBUTING.md\nmise install + bun install\nmise run ci"]
        SEC["SECURITY.md\nGitHub private reporting\nsecurity@pleaseai.dev"]
    end
    subgraph GH[".github/"]
        PR_TPL[".github/PULL_REQUEST_TEMPLATE.md"]
        BUG[".github/ISSUE_TEMPLATE/bug_report.md"]
        FEAT[".github/ISSUE_TEMPLATE/feature_request.md"]
        CFG[".github/ISSUE_TEMPLATE/config.yml\nblank_issues_enabled: false"]
    end
    subgraph Changed["Modified files"]
        PKG["package.json\nadded license: Apache-2.0"]
        README["README.md\nadded npm + license badges"]
    end
    LICENSE -->|required by| NOTICE
    SEC -->|cross-references| CFG
    CONTRIB -->|cross-references| COC
    CONTRIB -->|cross-references| SEC
Loading
%%{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
    subgraph Root["Repository Root (new files)"]
        LICENSE["LICENSE\nApache-2.0 full text\nCopyright 2026 Passion Factory"]
        NOTICE["NOTICE\nAttribution to vercel-labs/emulate\nChris Tate, Copyright 2025"]
        COC["CODE_OF_CONDUCT.md\nContributor Covenant 2.1\nconduct@pleaseai.dev"]
        CONTRIB["CONTRIBUTING.md\nmise install + bun install\nmise run ci"]
        SEC["SECURITY.md\nGitHub private reporting\nsecurity@pleaseai.dev"]
    end
    subgraph GH[".github/"]
        PR_TPL[".github/PULL_REQUEST_TEMPLATE.md"]
        BUG[".github/ISSUE_TEMPLATE/bug_report.md"]
        FEAT[".github/ISSUE_TEMPLATE/feature_request.md"]
        CFG[".github/ISSUE_TEMPLATE/config.yml\nblank_issues_enabled: false"]
    end
    subgraph Changed["Modified files"]
        PKG["package.json\nadded license: Apache-2.0"]
        README["README.md\nadded npm + license badges"]
    end
    LICENSE -->|required by| NOTICE
    SEC -->|cross-references| CFG
    CONTRIB -->|cross-references| COC
    CONTRIB -->|cross-references| SEC
Loading

Reviews (4): Last reviewed commit: "chore: restore canonical Apache-2.0 lice..." | Re-trigger Greptile

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 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 `@LICENSE`:
- Around line 185-188: The LICENSE file currently includes extra employer-IP
guidance mixed into the Apache-2.0 boilerplate, which makes it no longer match
the standard text. Remove that note from LICENSE or move it to separate
documentation, and keep the Apache-2.0 appendix text verbatim; use the existing
LICENSE content near the appended boilerplate to locate the offending paragraph.
🪄 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: fe5c07c6-8d26-4569-84fc-e487a0c6dae3

📥 Commits

Reviewing files that changed from the base of the PR and between a5adeba and ca1ff9a.

📒 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
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • LICENSE
  • NOTICE
  • README.md
  • SECURITY.md
  • package.json

Comment thread LICENSE Outdated

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 11 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="LICENSE">

<violation number="1" location="LICENSE:185">
P2: Keep the Apache 2.0 appendix boilerplate verbatim. This custom employer-IP sentence alters the canonical license text and can create ambiguity about the applied license terms.</violation>
</file>
Architecture diagram
sequenceDiagram
    participant Repo as Repository
    participant GitHub as GitHub platform
    participant npm as npm registry
    participant Dev as Contributors

    Note over Repo,Dev: PR adds standard OSS files (no code change)

    Dev->>GitHub: Opens issue using NEW: issue template
    GitHub->>Repo: Renders template (bug/feature/security)
    Repo-->>GitHub: Template fields

    Dev->>GitHub: Submits PR using NEW: PR template
    Repo-->>GitHub: LICENSE + NOTICE metadata

    GitHub->>Repo: Reads CODE_OF_CONDUCT + SECURITY for enforcement
    Repo-->>GitHub: Enforcement contacts + reporting channel

    npm->>Repo: Reads license field (NEW: root package.json)
    Repo-->>npm: "Apache-2.0" + LICENSE file

    Dev->>npm: Queries package version via badge (NEW: npm badge)
    npm-->>Dev: Latest version

    Note over Repo,Dev: No runtime request/data flow changes
Loading

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread LICENSE Outdated
amondnet added 3 commits July 2, 2026 01:45
Satisfies the jsonc/sort-keys lint rule from @pleaseai/eslint-config,
which was failing CI (Lint step) on this branch.
Restores three operative-term wordings that upstream vercel-labs/emulate had
altered from the canonical text ("submitted to Licensor", "received by
Licensor", "excluding those notices"). The LICENSE body is now byte-for-byte
identical to https://www.apache.org/licenses/LICENSE-2.0.txt except the
appendix copyright line (Copyright 2026 Passion Factory).
@sonarqubecloud

sonarqubecloud Bot commented Jul 1, 2026

Copy link
Copy Markdown

@amondnet amondnet merged commit 962b44a into main Jul 14, 2026
9 of 11 checks passed
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