Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
84 lines (56 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

84 lines (56 loc) · 2.5 KB

Contributing

Thanks for your interest in StackFoundry.

Local Development

Use the package manager and Node.js version declared in package.json.

corepack enable
pnpm install
pnpm check

Useful focused commands:

pnpm registry:doctor
pnpm registry:build
pnpm lint
pnpm test
pnpm dev:web

Adding a Module

A module should include:

  • module.json
  • source files when the module is ready, experimental, or stable
  • docs.md
  • skill/SKILL.md
  • tests/checklist.md

Use GitHub module/provider requests for proposed capabilities that do not install source yet. Use ready only when the module has installable source files and passes registry validation.

Provider Adapters

Provider contributions are welcome. Keep adapters optional and focused:

  • Add provider-specific code in its own module instead of coupling it to source-owned defaults.
  • Reference shared provider skills from registry/skills/<provider>/SKILL.md when possible.
  • Document required environment variables, dashboard resources, webhook setup, and smoke-test steps.
  • Do not commit provider credentials, project IDs, customer data, .env*, or generated local state.

Recipes And Presets

Recipes explain install order and architecture. Presets install bundles. If your provider belongs in a larger workflow, update the relevant recipe or preset and regenerate public/r.

Pull Requests

Each PR should focus on one phase or one module.

Good public PR shapes:

  • one new provider adapter
  • one ready module implementation
  • one proposal-to-ready module promotion
  • one recipe/preset update with generated registry output
  • one docs-only clarification

Include:

  • summary
  • test plan
  • docs changes
  • screenshots/GIFs for UI changes
  • public-safety checklist

Do not include secrets, private customer data, local environment files, or generated caches.

For high-volume contribution review, keep generated output in the same PR as the source manifest change and avoid unrelated formatting churn. Registry modules, provider adapters, recipes, docs, and examples are open contribution surfaces; hosted web app and repository automation changes are maintainer-owned.

CI/CD

Pull requests and pushes to main run the GitHub Actions quality gates in .github/workflows/ci.yml.

Production and preview deployments use .github/workflows/deploy-vercel.yml and require these repository secrets:

  • VERCEL_TOKEN
  • VERCEL_ORG_ID
  • VERCEL_PROJECT_ID

Do not commit .vercel/, .env*, provider credentials, or generated deployment state.