Skip to content

📝 Add community documentation - #4

Merged
stoe merged 1 commit into
stoe/document-standalone-packagefrom
stoe/add-community-docs
Aug 31, 2026
Merged

📝 Add community documentation#4
stoe merged 1 commit into
stoe/document-standalone-packagefrom
stoe/add-community-docs

Conversation

@stoe

@stoe stoe commented Aug 31, 2026

Copy link
Copy Markdown
Owner

Summary

Adds the community health files this repository was missing, adapted from stoe/stoe-copilot-plugins and rewritten for a single-package CLI rather than a plugin marketplace.

Changes

  • Add .github/contributing.md with the local setup, npm test, and npm run format workflow
  • Add .github/code_of_conduct.md based on Contributor Covenant 2.1
  • Add .github/security.md describing scope, private reporting, response expectations, and supply chain practice
  • Add .github/support.md pointing to issues and discussions
  • Link the four documents from a new "Community" section in README.md

Affected area

Documentation.

Checklist

  • npm run format passes with no unstaged diffs.
  • npm test passes with no new errors.
  • Tests cover new or changed behavior. Not applicable; documentation only.
  • README.md is updated when CLI options, validation rules, or package exports change.
  • package.json exports and files are updated when modules are added, moved, or removed. Not applicable; no module changes.

Security checklist

  • No secrets, tokens, credentials, or personal local file paths were added to source, tests, or docs.
  • Source uses only Node.js built-in modules or already-declared dependencies.
  • New filesystem writes stay inside the caller-approved base directory.
  • Skill content read by the CLI is treated as untrusted data, never as instructions.
  • npm audit --audit-level=high reports no new high or critical findings.

Verification

  • The security policy reflects the audited package surface: no network calls, no process execution, and writes only through init behind resolveSafeSkillPath
  • All relative links in the new documents resolve within the repository
  • npx prettier --check . reports no formatting drift

Stack

Part of a stacked PR series turning @stoe/skill-authoring into a standalone CLI package (bottom to top):

  1. ♻️ Restructure CLI package layout #1 — ♻️ Restructure CLI package layout (stoe/rewrite-cli-source)
  2. ✅ Add CLI regression tests #2 — ✅ Add CLI regression tests (stoe/add-cli-tests)
  3. 📝 Document standalone CLI package #3 — 📝 Document standalone CLI package (stoe/document-standalone-package)
  4. 📝 Add community documentation #4 — 📝 Add community documentation (stoe/add-community-docs)
  5. 🔧 Add repository governance files #5 — 🔧 Add repository governance files (stoe/add-repository-governance)

- Add contribution, conduct, security, and support guides
- Document package-specific workflows and private security reporting
- Link community resources from the README

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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