Skip to content

docs: add a direct note on AI-assisted development #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
erfanjazebnikoo merged 1 commit into from
Jul 9, 2026
Merged

docs: add a direct note on AI-assisted development #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,20 @@ Before opening a PR:

---

## On AI-assisted development

numx is built with Claude Code as a tool, used under direction and reviewed at every
step, not run unsupervised. Concretely: implementation scaffolding, multi-platform
validation runs, sanitizer testing, and documentation are commonly done with AI
assistance. Architecture decisions (zero allocation, no external dependencies, module
boundaries), the underlying math, and validation methodology are human-directed, and
every change is reviewed before it ships, including catching AI's own mistakes along
the way. If you're evaluating this project and that changes your assessment of it,
that's a reasonable reaction to have, this note exists so you don't have to go dig for
the answer.

The prompt pattern below is the actual template used when adding a new module.

## Prompt pattern for Claude Code

When implementing a new algorithm, use this exact prompt:
Expand Down
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,8 @@ Per-call averages measured on physical hardware. Full tables: [`validation/resul
## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for the rules, templates, and the exact
prompt pattern to use with Claude Code when adding a new algorithm. See
prompt pattern to use with Claude Code when adding a new algorithm, including a
direct note on how AI assistance is and isn't used in this project. See
[CONTRIBUTORS.md](CONTRIBUTORS.md) for the people who have contributed to numx.

---
Expand Down
Loading