chore: polish open source repo metadata

2026-08-28 02:44:59 +00:00 · 2026-05-04 01:46:24 -05:00 · 2026-05-04 01:46:24 -05:00 · ab7ea4642b
commit ab7ea4642b
parent 55d98a6017
9 changed files with 78 additions and 25 deletions
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@ -32,9 +32,9 @@ If applicable, add screenshots to help explain your problem.
 ## Environment

 - **OS:** [e.g., macOS 14.1, Windows 11, Ubuntu 22.04]
- **Node.js version:** [e.g., 18.17.0]
+- **Node.js version:** [e.g., 22.13.0]
 - **Browser:** [e.g., Chrome 120, Safari 17]
- **Veritas Kanban version:** [e.g., 1.0.0]
+- **Veritas Kanban version:** [e.g., 4.0.1]

 ## Additional Context

--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@ -11,7 +11,7 @@ concurrency:
  cancel-in-progress: true

 env:
-  NODE_VERSION: '20'
+  NODE_VERSION: '22'

 jobs:
  # ─── Lint & Type Check ───────────────────────────────────────────
--- a/.gitignore
+++ b/.gitignore
@ -47,6 +47,7 @@ tasks/archive-attachments/

 # Historical broken config data (should never have been tracked)
 .veritas-kanban.broken/
+.safety/

 # Test
 coverage/
@ -98,6 +99,9 @@ backups/

 # Internal data directories - NEVER commit
 tasks/
+!tasks/
+!tasks/examples/
+!tasks/examples/*.md
 .veritas-kanban/

 # Local security middleware (not shared)
--- a/.safety/pre-purge-20260204-005610-refs.txt
+++ b/.safety/pre-purge-20260204-005610-refs.txt
@ -1,18 +0,0 @@
-907be2d1652a07105b826d444d82b269b2d7dcb1 refs/heads/feat/backlog-board-65
-8194603b3bde301d330cf3c5330dc18f390c8235 refs/heads/feat/dev-reliability-82
-e07eca0113bc1a59a3e689d410c7de3468d96902 refs/heads/feat/dev-reliability-82-v2
-0c8b45b375fd150d957925d5d6dc5791717667bb refs/heads/main
-0c8b45b375fd150d957925d5d6dc5791717667bb refs/remotes/origin/HEAD
-1dfb28de5b35987d9f9de6d822451c4b5c788aeb refs/remotes/origin/feat/dashboard-filter-bar-56
-e07eca0113bc1a59a3e689d410c7de3468d96902 refs/remotes/origin/feat/dev-reliability-82-v2
-fd37282d049cfbc5f8e79c09f08deae7a7f38f24 refs/remotes/origin/feat/v1.5-model-usage
-3dc63003119ca03d71c141512e0bfbe4c37dc881 refs/remotes/origin/fix/docker-cwd-root-62
-53b872cb4fdc748e5936a45a0cfc78d382348dd1 refs/remotes/origin/fix/timer-stop-cache-race-7
-0c8b45b375fd150d957925d5d6dc5791717667bb refs/remotes/origin/main
-fbd139a8cba856234bf18ff98ba48e7cff25c48e refs/stash
-2797b97c4cb81acc42df9e2774bc21849ba2600b refs/tags/v1.0.0
-1ec6d8dfa83568269793a9e7b61a3a7e31f71793 refs/tags/v1.1.0
-abb6f63f20351729b192a245e7419afe40261e5d refs/tags/v1.2.0
-18daeb322d420d4853879dc0178096b7a7d46d5c refs/tags/v1.3.0
-d4d96d02bfe89bcafae9e5a956d029127a3fb61c refs/tags/v1.4.0
-730a7e05f426d74029eed270a405bc8d28608779 refs/tags/v1.4.1
--- a/.safety/pre-purge-20260204-005610.bundle
+++ b/.safety/pre-purge-20260204-005610.bundle
--- a/README.md
+++ b/README.md
@ -11,7 +11,7 @@ Built for developers who want a visual Kanban board that works with autonomous c
 [![CI](https://github.com/BradGroux/veritas-kanban/actions/workflows/ci.yml/badge.svg)](https://github.com/BradGroux/veritas-kanban/actions/workflows/ci.yml)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
 [![Version](https://img.shields.io/badge/version-4.0.1-blue.svg)](CHANGELOG.md)
-[![TypeScript](https://img.shields.io/badge/TypeScript-5.7-blue.svg)](https://www.typescriptlang.org/)
+[![TypeScript](https://img.shields.io/badge/TypeScript-6.0-blue.svg)](https://www.typescriptlang.org/)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)

 ![Veritas Kanban — Board Overview](assets/demo-overview.gif)
@ -81,7 +81,7 @@ Open [http://localhost:3000](http://localhost:3000) — that's it. The board aut

 ### Best Practices for Agentic AI

-1. **Run locally first.** Keep your board and agents on your own machine until you fully understand the behavior. Never expose an unauthenticated instance to the internet. **Veritas Kanban does not include rate limiting** — if you deploy publicly, add a reverse proxy (nginx, Caddy, Cloudflare) with rate limiting in front of it.
+1. **Run locally first.** Keep your board and agents on your own machine until you fully understand the behavior. Never expose an unauthenticated instance to the internet. Veritas Kanban includes built-in API rate limiting, but if you deploy publicly, still add a reverse proxy (nginx, Caddy, Cloudflare) with edge-level rate limiting in front of it.

 2. **Never trigger agents from uncontrolled inputs.** Don't let inbound emails, webhooks from third parties, or public form submissions automatically spawn agent work. An attacker who can craft an input can control your agent.

@ -137,7 +137,7 @@ Isolated worktrees per task — no branch switching, no conflicts. Built-in code

 ### 📁 Zero Infrastructure

-Tasks are markdown files. Settings are JSON. Workflows are YAML. No database, no Docker, no Redis. Clone, `pnpm install`, `pnpm dev` — done. Everything is `grep`-friendly, version-controllable, and human-readable. Back up your entire board with `git push`.
+Tasks are markdown files. Settings are JSON. Workflows are YAML. No database, no Redis, and no Docker required for local use. Clone, `pnpm install`, `pnpm dev` — done. Everything is `grep`-friendly, version-controllable, and human-readable. Back up your entire board with `git push`.

 ### 🔌 Three Integration Surfaces

@ -273,7 +273,7 @@ Tasks are markdown files. Settings are JSON. Workflows are YAML. No database, no
 | ------------------- | ------------------------------------ | -------------------------------- |
 | **Frontend**        | React, Vite, Tailwind CSS, Shadcn UI | React 19, Vite 7.3, Tailwind 4.2 |
 | **Backend**         | Express, WebSocket                   | Express 5.2                      |
-| **Language**        | TypeScript (strict mode)             | 5.7                              |
+| **Language**        | TypeScript (strict mode)             | 6.0                              |
 | **Storage**         | Markdown files with YAML frontmatter | gray-matter                      |
 | **Git**             | simple-git, worktree management      | —                                |
 | **Testing**         | Playwright (E2E), Vitest (unit)      | Playwright 1.58, Vitest 4        |
--- a/tasks/examples/task_example_001-connect-your-first-agent.md
+++ b/tasks/examples/task_example_001-connect-your-first-agent.md
@ -0,0 +1,22 @@
+---
+id: task_example_001
+title: Connect your first agent
+type: setup
+status: todo
+priority: high
+project: Welcome
+created: '2026-05-04T00:00:00.000Z'
+updated: '2026-05-04T00:00:00.000Z'
+position: 1000
+subtasks:
+  - id: subtask_example_001_a
+    title: Copy server/.env.example to server/.env
+    completed: false
+    created: '2026-05-04T00:00:00.000Z'
+  - id: subtask_example_001_b
+    title: Set VERITAS_ADMIN_KEY to a local development value
+    completed: false
+    created: '2026-05-04T00:00:00.000Z'
+---
+
+Use this task as a quick smoke test for your local setup. Start Veritas Kanban, confirm the board loads, then connect an agent or API client with your local admin key.
--- a/tasks/examples/task_example_002-try-the-task-lifecycle.md
+++ b/tasks/examples/task_example_002-try-the-task-lifecycle.md
@ -0,0 +1,22 @@
+---
+id: task_example_002
+title: Try the task lifecycle
+type: workflow
+status: in-progress
+priority: medium
+project: Welcome
+created: '2026-05-04T00:00:00.000Z'
+updated: '2026-05-04T00:00:00.000Z'
+position: 2000
+subtasks:
+  - id: subtask_example_002_a
+    title: Move a card between columns
+    completed: true
+    created: '2026-05-04T00:00:00.000Z'
+  - id: subtask_example_002_b
+    title: Add a comment or observation
+    completed: false
+    created: '2026-05-04T00:00:00.000Z'
+---
+
+Drag this card across the board, open the detail panel, and try a comment, subtask, or time entry. The goal is to make the file-backed workflow feel concrete.
--- a/tasks/examples/task_example_003-review-agent-safety-settings.md
+++ b/tasks/examples/task_example_003-review-agent-safety-settings.md
@ -0,0 +1,23 @@
+---
+id: task_example_003
+title: Review agent safety settings
+type: governance
+status: blocked
+priority: medium
+project: Welcome
+created: '2026-05-04T00:00:00.000Z'
+updated: '2026-05-04T00:00:00.000Z'
+position: 3000
+blockedReason:
+  category: waiting-on-feedback
+  note: Decide which tools your agents should be allowed to use.
+verificationSteps:
+  - id: verify_example_003_a
+    description: Confirm public deployments sit behind a reverse proxy
+    checked: false
+  - id: verify_example_003_b
+    description: Confirm destructive actions require human review
+    checked: false
+---
+
+Before giving agents meaningful access, review auth, rate limiting, tool policies, and your expectations for human approval. Start small and increase autonomy once the guardrails are familiar.