Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (34 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

47 lines (34 loc) · 2.2 KB
Raw

Contributing to StackBrief

Thank you for helping make repository changes easier to understand before they happen.

Before opening a pull request

npm ci
npm test
npm run test:package

cd apps/web
npm ci
npm run build

Contribution principles

  • Preserve offline, deterministic analysis. Do not introduce hosted AI calls into the scanner, knowledge model, or brief path.
  • Add source evidence for new findings wherever practical.
  • Keep the versioned stackbrief.json schema backward compatible. Any breaking schema change requires a version increment and migration note.
  • Add focused tests for framework detectors, resolver behavior, knowledge relations, and brief output.
  • Do not silently infer business intent from code. Report observable facts and static unknowns separately.
  • Keep the CLI and apps/web independently buildable.
  • Treat documentation as implementation: review the README, CLI examples, architecture notes, schema notes, website copy, and onboarding guidance when behavior changes.

Release discipline

Every meaningful public CLI release must be documented before it is tagged or published.

  1. Select the semantic version that matches the shipped compatibility change.
  2. Update package.json, package-lock.json, and CHANGELOG.md together.
  3. Prepare a versioned GitHub Release body with Added, Changed, Improved, Fixed, Breaking Changes, and Migration Notes sections. Write None where a section does not apply; do not imply a change that did not ship.
  4. Review documentation and examples against the released behavior.
  5. Run the CLI test suite, package smoke test, and independent website build.

The published CLI package version is StackBrief’s public release contract. Private website or demo workspace metadata does not imply a separate npm release.

Where to help

  • Framework-aware route and entry-point detection
  • Language-aware parsing and import resolution
  • Clearer architecture evidence and false-positive reduction
  • Documentation, examples, and real-repository fixtures
  • Agent integrations that consume StackBrief’s portable instruction artifact

For a larger proposal, open an issue first or email hello@mojeeb.xyz.