Skip to content

Latest commit

 

History

History
313 lines (252 loc) · 11.9 KB

File metadata and controls

313 lines (252 loc) · 11.9 KB

GitHub Community Issue Pack

Use this file to seed contributor-friendly GitHub issues after a release. The issue list should reflect real engineering work that would make the repository more useful, easier to run, or easier to adapt. Do not create placeholder issues only for activity metrics.

Wave 1 Completed Issues

The first public issue wave was created after the initial release and is now complete:

  • Add README demo GIF
  • Add CSV export for eval summaries
  • Add OpenTelemetry-compatible trace export
  • Add PostgreSQL and pgvector adapter design
  • Add replayable demo reset script
  • Add trace deep links in the demo UI
  • Add a local seed-data editor prototype
  • Add keyboard-friendly trace navigation for recent trace lists
  • Add copyable scenario-draft import/export snippets for local demos
  • Add a compact diff view for browser-local scenario drafts
  • Add a reduced-motion and focus-visible accessibility pass
  • Add browser-local light/dark theme controls to all demo UIs
  • Add high-contrast screenshot checks for visual assets
  • Add mobile viewport screenshots to the visual asset manifest
  • Add compact visual asset diff summaries for screenshot refreshes
  • Add visual asset refresh troubleshooting notes
  • Add per-asset captions for screenshot galleries
  • Add a README command quick-reference
  • Add a compact README glossary for core gates
  • Add a README maintainer workflow checklist
  • Add a compact README demo path map
  • Add README command output expectations
  • Add a compact README troubleshooting pointer
  • Add a compact README screenshot reviewer checklist
  • Add a compact README command decision tree
  • Add a compact README evidence legend
  • Add a compact README contributor route map
  • Add a compact README production-upgrade pointer
  • Add a compact README release-evidence FAQ
  • Add compact per-project risk badges
  • Add a compact README operational runbook index
  • Add a compact README evidence freshness checklist
  • Add a compact README reviewer handoff checklist
  • Add compact per-project architecture cards to the README
  • Add shareable demo-state reset presets
  • Add a compact README demo recording checklist pointer
  • Add a compact README launch-channel checklist pointer
  • Add a compact README contribution safety summary pointer
  • Add a compact README release artifact attachment pointer
  • Add a compact README optional-environment evidence pointer
  • Add a compact README connector roadmap pointer
  • Add a compact README eval regression report pointer
  • Add a compact README storage adapter evidence pointer
  • Add a compact README red-team eval expansion pointer
  • Add a compact README OpenTelemetry backend pointer
  • Add a compact README Docker runtime evidence pointer
  • Add a compact README dependency surface evidence pointer
  • Add a compact README API contract evidence pointer
  • Add a compact README error hygiene evidence pointer
  • Add a compact README model gateway safety evidence pointer
  • Add a compact README PR triage evidence pointer
  • Add a compact README threat model evidence pointer
  • Add a compact README workflow security evidence pointer
  • Add a compact README governance evidence pointer
  • Add a compact README launch asset evidence pointer
  • Add a compact README reviewer handoff evidence pointer
  • Add a compact README post-publish evidence pointer
  • Add a compact README GitHub readiness evidence pointer
  • Add a compact README release page evidence pointer
  • Add an API request cookbook for canonical demo paths
  • Add a contributor code-tour page for service boundaries
  • Add an eval authoring guide for safe AI workflows
  • Add seed-data extension examples for canonical scenarios
  • Add local API error examples
  • Add a trace timeline explainer for canonical flows
  • Add local eval gate troubleshooting examples
  • Add a small glossary for local data and evidence artifacts
  • Add a command-output troubleshooting map for common gates
  • Add a local demo reset troubleshooting guide for stale runtime state
  • Add a seed fixture data-flow map
  • Add a contributor onboarding checklist for the first local pull request
  • Add docs-only pull request review examples
  • Add docs-only review comments for common PR outcomes
  • Add a README-to-docs navigation audit
  • Add compact examples for README navigation drift fixes
  • Add OpenTelemetry collector handoff troubleshooting notes
  • Add optional OpenAI live-mode troubleshooting notes
  • Add a Docker runtime evidence collection checklist
  • Add compact Docker runtime failure examples
  • Add compact docs for issue-to-PR handoff flow
  • Add compact release attachment verification examples
  • Add compact eval CSV troubleshooting examples
  • Add compact branch protection verification examples
  • Add compact post-publish warning examples
  • Add compact GitHub label troubleshooting examples
  • Add compact GitHub Actions warning examples
  • Add compact GitHub release page troubleshooting examples
  • Add compact social preview verification examples
  • Add compact GitHub repository metadata troubleshooting examples
  • Add compact GitHub API rate-limit troubleshooting examples
  • Add compact GitHub latest release troubleshooting examples
  • Add compact profile pin verification examples
  • Add compact authenticated maintenance troubleshooting examples
  • Add compact GitHub public PR API fallback troubleshooting examples
  • Add compact repository settings screenshot checklist
  • Add compact launch feedback collection examples
  • Add compact GitHub release attachment screenshot checklist
  • Add compact GitHub Actions badge verification examples
  • Add compact Dependabot and secret-scanning verification examples
  • Add compact public roadmap issue comment examples
  • Add compact release asset upload dry-run examples
  • Add compact repository discussions launch checklist
  • Add compact release note refresh checklist
  • Add compact contributor attribution examples
  • Add compact issue triage SLA wording examples
  • Add compact discussion-to-issue conversion examples
  • Add compact release-note changelog drift examples
  • Add compact public maintainer status update examples
  • Add compact roadmap duplicate-issue handling examples
  • Add compact issue template stale-evidence examples
  • Add compact stale launch-feedback claim examples
  • Add compact release asset checksum mismatch examples
  • Add compact stale GitHub Discussions pin examples
  • Add compact stale release-page screenshot examples
  • Add compact stale profile-pin evidence examples
  • Add compact stale social-preview cache examples
  • Add compact stale repository topics evidence examples
  • Add compact stale branch-protection screenshot examples
  • Add compact stale GitHub Actions badge cache examples
  • Add compact stale Dependabot alert evidence examples

Keep this record so future maintainers understand why those capabilities already exist in the repository.

Issue 1

Title:

Add a FastAPI adapter for one service

Labels:

enhancement, production-upgrade

Body:

Add a FastAPI adapter for one existing service while keeping the current stdlib HTTP server as the default local path.

Acceptance criteria:

- Adapter lives behind a separate entrypoint or documented optional path.
- Existing API response shapes remain compatible with docs/api_contracts.md.
- The default local demo path still runs without third-party dependencies.
- Update docs/production_upgrade_notes.md with the adapter boundary.
- python -B scripts/dev.py contracts still passes.
- python -B scripts/dev.py verify still passes.

Issue 2

Title:

Implement a PostgreSQL storage adapter prototype

Labels:

enhancement, production-upgrade

Body:

Prototype a PostgreSQL-backed storage adapter for one service based on docs/postgres_pgvector_adapter_design.md.

Acceptance criteria:

- Local JSON storage remains the default.
- Adapter has a clear feature flag or separate entrypoint.
- Migration/schema notes include audit log, trace, and eval-state isolation.
- Permission checks remain before answer generation or side-effect execution.
- Add focused tests or a deterministic check script for adapter shape.
- python -B scripts/dev.py quality still passes.

Issue 3

Title:

Add per-case eval regression reports

Labels:

enhancement, eval

Body:

Add a report that compares current eval results with a checked-in baseline and highlights changed cases.

Acceptance criteria:

- Report includes project, case id, pass/fail transition, latency, and unsafe failure counts.
- Generated report artifacts stay ignored unless intentionally committed as release evidence.
- The report does not weaken deterministic safety assertions.
- Documentation explains when to use the report during release review.
- python -B scripts/dev.py evals still passes.
- python -B scripts/dev.py claims still passes.

Issue 4

Title:

Add red-team eval cases for retrieval and agent governance

Labels:

security, eval

Body:

Expand the eval suite with additional prompt-injection, unauthorized-access, and approval-bypass cases.

Acceptance criteria:

- Project 1 adds retrieval or user-message attack cases that must abstain without leaking inaccessible evidence.
- Project 2 adds approval-bypass cases that must not execute side effects.
- Project 3 adds at least one release-risk case that must block rollout.
- Update docs/threat_model.md or project threat docs if new threat patterns are introduced.
- Unsafe leak, direct side-effect, and release approval failure counts remain zero.
- python -B scripts/dev.py quality still passes.

Issue 5

Title:

Add compact stale GitHub release asset evidence examples

Labels:

documentation, good first issue

Body:

Add compact stale GitHub release asset evidence examples that explain how to handle old release attachment screenshots, wrong release tags, stale asset names, local `out/` files, and private release-edit UI crops without turning stale asset evidence into current public release evidence.

Acceptance criteria:

- Add docs/stale_github_release_asset_evidence_examples.md with examples for old release attachment screenshots, wrong release tags, stale asset names, local `out/` files, and private release-edit UI crops.
- Reference docs/release_attachment_verification_examples.md, docs/release_asset_upload_dry_run_examples.md, docs/release_asset_checksum_mismatch_examples.md, docs/post_publish_warning_examples.md, and docs/post_publish_checklist.md.
- Keep public release attachments, checked-in release notes, generated local `out/` files, release-page screenshots, private release-edit UI crops, and source docs separate; do not claim release asset evidence is current until post-publish or GitHub readiness evidence confirms it.
- Link the examples from README.md and PROJECT_CONTENT_INDEX.md.
- python -B scripts/dev.py github-readiness remains the public/account-level follow-up command.
- python -B scripts/dev.py replay-artifact still passes.
- python -B scripts/dev.py launch-assets still passes.
- python -B scripts/dev.py safety still passes.
- python -B scripts/dev.py quality still passes.

Issue 6

Title:

Run and document Docker Compose runtime verification

Labels:

documentation, docker, release

Body:

Run the Docker runtime verification on a Docker-enabled machine and publish the evidence.

Acceptance criteria:

- Run python -B scripts/dev.py docker-runtime on a Docker-enabled machine.
- Record the exact environment and result in docs/container_release_hygiene.md.
- Add screenshots only if they reflect the current running services.
- Do not claim Docker runtime verification until the command passes.
- python -B scripts/dev.py container-release still passes.

Guardrails

  • Do not create issues that require secret values, token values, private files, or account access.
  • Do not create issues that weaken permission checks, approval gates, evals, traces, or public safety scans.
  • Keep local-first behavior intact unless an issue explicitly adds an optional production adapter.
  • Every issue should include acceptance criteria and at least one verification command.