haskytech/bug-reporter
7
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

docs: add 4 scaffolding files [skip cd] #31

Merged
john merged 1 commit from feat/scaffolding into dev 2026-06-24 16:39:27 +00:00
Conversation 0 Commits 1 Files changed 4 +278
john commented 2026-06-24 16:35:16 +00:00
Owner
Copy link

Adds missing scaffolding files for standardization and compliance:

Files Added

  1. docs/ops/key_info.md — Project registry, Forgejo npm publish workflow, dependencies, external APIs
  2. docs/constraints.md — Engineering constraints covering TypeScript, build, network capture, UI components, config, testing, CI
  3. docs/contracts/api-surface.yaml — Complete API surface: exports, outbound APIs (BugReport POST), network capture, custom elements, capture modules
  4. .workstream/manifest.yaml — Project metadata, branching model, build config, dispatch status, contacts

Scope

Bug Reporter is a browser-integrated SDK (not a deployed app) published to Forgejo npm registry as @haskytech/bug-reporter. These files document the library's contract, constraints, and lifecycle.

Notes

  • No Docker or deploy steps (npm publication via git tag)
  • API surface accurately reflects code: POST endpoint for bug reports, optional Bearer auth, Web Components (<bug-reporter-button>, <bug-reporter-dialog>), 8 capture modules
  • Constraints reflect actual implementation: Web Components + Shadow DOM, Vite library mode (ESM + CJS), TypeScript strict, pnpm + Node 22 in CI

🤖 Generated with Claude Code

Adds missing scaffolding files for standardization and compliance: ## Files Added 1. **docs/ops/key_info.md** — Project registry, Forgejo npm publish workflow, dependencies, external APIs 2. **docs/constraints.md** — Engineering constraints covering TypeScript, build, network capture, UI components, config, testing, CI 3. **docs/contracts/api-surface.yaml** — Complete API surface: exports, outbound APIs (BugReport POST), network capture, custom elements, capture modules 4. **.workstream/manifest.yaml** — Project metadata, branching model, build config, dispatch status, contacts ## Scope Bug Reporter is a browser-integrated SDK (not a deployed app) published to Forgejo npm registry as `@haskytech/bug-reporter`. These files document the library's contract, constraints, and lifecycle. ## Notes - No Docker or deploy steps (npm publication via git tag) - API surface accurately reflects code: POST endpoint for bug reports, optional Bearer auth, Web Components (`<bug-reporter-button>`, `<bug-reporter-dialog>`), 8 capture modules - Constraints reflect actual implementation: Web Components + Shadow DOM, Vite library mode (ESM + CJS), TypeScript strict, pnpm + Node 22 in CI 🤖 Generated with Claude Code
docs: add scaffolding files (key_info, constraints, api-surface, manifest)
All checks were successful
CI / Detect Changes (pull_request) Successful in 5s
Details
CI / Build & Lint (pull_request) Has been skipped
Details
CI / Docker Build (pull_request) Successful in 35s
Details
754ff842e6 
- docs/ops/key_info.md: project registry, registry target, CI/CD notes
- docs/constraints.md: TypeScript/build/capture/UI/config/testing constraints
- docs/contracts/api-surface.yaml: exports, outbound APIs, webhooks, custom elements
- .workstream/manifest.yaml: project metadata, branching, build, dispatch status

[skip cd]

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
john merged commit e9d340d416 into dev 2026-06-24 16:39:27 +00:00
john deleted branch feat/scaffolding 2026-06-24 16:39:27 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
haskytech/bug-reporter!31
No description provided.