project-engineering

Enforce engineering best practices for JAX/Equinox numerical codebases.

7|1|Updated Jan 26, 2026
One-click install
npx skills add https://github.com/quattro/jax-numerics-agent --skill project-engineering
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-engineering
Source: https://github.com/quattro/jax-numerics-agent/tree/main/skills/project_engineering
Command: npx skills add https://github.com/quattro/jax-numerics-agent --skill project-engineering

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Engineering rules and best practices to ensure API stability, robust documentation, and reliable CI for JAX/Equinox numerical codebases.

Core Features & Use Cases

  • API stability: preserve return shapes and deprecate safely
  • Documentation & typing: align docstrings, typing, and project metadata; centralize configuration
  • CI, testing, serialization: enforce tests, format, and deterministic state handling

Quick Start

Apply the project engineering skill to enforce API stability, CI, and serialization in JAX/Equinox projects.

Frequently Asked Questions about project-engineering

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I maintain API stability and preserve return shapes in JAX codebases?

To maintain API stability in JAX codebases, apply engineering rules that preserve return shapes and implement safe deprecation strategies. This ensures consistent function signatures and prevents breaking changes across numerical Python projects using JAX and Equinox.

What's the best way to enforce type checking and align documentation in Equinox projects?

The best way to enforce type checking and align documentation in Equinox projects is by applying centralized configuration rules. This aligns docstrings, typing annotations, and project metadata to ensure robust, clearly documented numerical codebases.

How do I set up CI pipelines for deterministic state handling in JAX numerical projects?

To set up CI pipelines for deterministic state handling in JAX projects, enforce engineering rules for testing, formatting, and serialization. This guarantees deterministic CLI behavior and reliable state management across your numerical codebase.

Can I use these engineering rules for deprecating APIs safely in numerical Python projects?

Yes, you can use these engineering rules to deprecate APIs safely in numerical Python projects. They provide structured deprecation strategies that preserve API stability and return shapes while transitioning JAX and Equinox codebases.

Why does centralized configuration matter for JAX and Equinox typing and documentation?

Centralized configuration matters for JAX and Equinox typing because it aligns project metadata, docstrings, and type checking in one place. This prevents configuration drift and ensures documentation accurately reflects the actual API shapes.

Are there limitations when enforcing serialization and deterministic CLI behavior in JAX projects?

A key limitation when enforcing serialization and deterministic CLI behavior in JAX projects is that rules strictly target numerical codebases using JAX and Equinox. They may not apply to non-numerical Python projects or frameworks outside this specific scope.