Skip to content

docs: jsfeat parity/refactor audit plan + cross-agent instructions - #48

Merged
kalwalt merged 3 commits into
devfrom
docs/parity-audit-and-agent-guides
Jul 6, 2026
Merged

docs: jsfeat parity/refactor audit plan + cross-agent instructions#48
kalwalt merged 3 commits into
devfrom
docs/parity-audit-and-agent-guides

Conversation

@kalwalt

@kalwalt kalwalt commented Jul 5, 2026

Copy link
Copy Markdown
Member

What & why

Adds a durable planning artifact comparing jsfeatNext against the original inspirit/jsfeat, plus cross-agent instruction files. No library code changes.

Produced via a structured /brainstorming session; tracked by #46.

Added

  • docs/jsfeat-parity-and-refactor-audit.md — the plan, organized in 5 axes + appendices:
    • Axis 1 — function-and-parameter-level feature parity (incl. missing haar / bbf)
    • Axis 2 — API/behavioral parity (jsfeatNext.jsfeatNext double namespace, static-vs-instance methods, per-instance cache)
    • Axis 3 — clean-code pitfalls (type-only stub files duplicating the ~3,900-line jsfeatNext.ts monolith)
    • Axis 4 — recommended target architecture + phased, test-gated migration
    • Axis 5 — build modernization (webpack → Vite) + dependency cleanup
    • Appendices — haar/bbf porting plan; Vitest characterization-test harness (Phase 0 gate)
  • AGENTS.md — canonical, tool-agnostic agent guidance (build commands, architecture, the stub/monolith gotchas)
  • CLAUDE.md — thin; @AGENTS.md import + Claude-specific notes
  • .agents/instructions.md, .github/copilot-instructions.md — pointers to AGENTS.md
  • .gitignore — ignore .idea/

Reviewer notes

🤖 Generated with Claude Code

- Add docs/jsfeat-parity-and-refactor-audit.md: function-level parity, API/behavioral divergences, clean-code pitfalls, recommended target architecture, webpack->Vite modernization, and haar/bbf porting plan
- Add canonical AGENTS.md; CLAUDE.md imports it; .agents/instructions.md and .github/copilot-instructions.md point to it
- Ignore .idea/ IDE files

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@kalwalt kalwalt self-assigned this Jul 5, 2026
@kalwalt kalwalt added enhancement New feature or request Typescript all about Typescript code design labels Jul 5, 2026
@kalwalt
kalwalt requested review from a team and removed request for a team July 5, 2026 21:36
@kalwalt kalwalt added this to the Parity & Modernization milestone Jul 5, 2026
@kalwalt
kalwalt changed the base branch from main to dev July 6, 2026 11:04
kalwalt and others added 2 commits July 6, 2026 13:07
Add a Git & contribution workflow section to the canonical AGENTS.md (and inline it in the Copilot instructions): open PRs against dev not main, and use Conventional Commits for messages. CLAUDE.md and .agents/instructions.md inherit this via the @AGENTS.md import/pointer.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@kalwalt
kalwalt merged commit ea05529 into dev Jul 6, 2026
4 checks passed
@kalwalt
kalwalt deleted the docs/parity-audit-and-agent-guides branch July 7, 2026 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

code design enhancement New feature or request Typescript all about Typescript

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant