Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (27 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

38 lines (27 loc) · 1.39 KB
Raw

Contributing

SupportDesk Intelligence is maintained by Karunanidhi Mishra as an OSS-oriented enterprise product foundation.

Working Agreement

  • Keep the codebase useful for enterprise developers, not tutorial consumers.
  • Preserve local setup clarity.
  • Prefer provider adapters and OSS/self-hosted alternatives over direct paid-SaaS coupling.
  • Never commit real secrets or customer data.
  • Record proof for meaningful changes.

Before You Change Code

  1. Read README.md.
  2. Read docs/DEVELOPER_ONBOARDING.md.
  3. Read docs/ARCHITECTURE_DEEP_DIVE.md.
  4. Check docs/PROVIDER_REPLACEMENT_PLAN.md before changing provider integrations.
  5. Check docs/THREAT_MODEL.md before changing sensitive data, access, provider, webhook, billing, or workflow paths.
  6. Check docs/AUDIT_OBSERVABILITY_PLAN.md before adding or changing audit, logging, health, provider, webhook, worker, or admin behavior.

Expected Proof

pnpm install --frozen-lockfile

Run available scripts from package.json, especially lint, typecheck, test, and build when present.

Use the Docker proof runner from the control workspace when you need isolated command evidence.

Pull Request Standard

  • Explain what changed.
  • List commands run.
  • List any skipped checks and why.
  • Mention provider, auth, billing, data, or deployment impact.
  • Update docs when runtime, routes, env vars, or provider dependencies change.