Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (29 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

39 lines (29 loc) · 1.34 KB
Raw

Contributing

Thanks for improving Discord Management MCP.

Maintainer: Michael Gasperini / TheStreamCode.

Local Development

npm ci
npm run lint
npm run typecheck
npm test
npm run build
npm run pack:check

Use Node.js >=24. Do not commit node_modules/, dist/, .env.local, backups, or logs.

Design Principles

  • Prefer safe-by-default behavior over convenience.
  • Keep read-only tools separate from mutating tools.
  • Require confirm: true and a non-empty reason for every mutation.
  • Require a guild-matched backup before destructive operations unless the caller explicitly opts out.
  • Never expose Discord bot tokens, webhook tokens, or .env.local contents.
  • Return structured content that is easy for MCP clients to inspect.

Pull Request Checklist

  • New tools have clear names and descriptions.
  • Inputs use Zod validation with useful bounds.
  • Mutating tools use confirmation guards and accurate MCP annotations.
  • Delete and other high-impact destructive tools use backup guards.
  • Error responses include actionable next steps.
  • Tests cover safety-critical behavior.
  • npm run preflight and npm run pack:check pass.

All changes should be submitted through pull requests. Direct pushes to the protected default branch are reserved for the maintainer bypass path.