Skip to content

Add AGENTS.md - #702

Merged
Rafael-SOWNet merged 2 commits into
ASC-Community:masterfrom
Rafael-SOWNet:docs/agents-md
Aug 4, 2026
Merged

Rafael-SOWNet merged 2 commits into
ASC-Community:masterfrom
Rafael-SOWNet:docs/agents-md

Conversation

@Rafael-SOWNet

Copy link
Copy Markdown
Member

Guidance for AI agents working on this repository. CONTRIBUTING.md covers how to build, test and open a PR; this covers how to do the mathematics, which is the part that actually goes wrong.

The substance:

  • Mathematical correctness outranks backward compatibility. A published API that returns the wrong answer is a bug with users, not an asset to preserve. Same for notation: arcsinh is not a thing, which is what Refuse the arc- spellings of the inverse hyperbolic functions #687 was about.
  • Consistency is the defect [Paper in progress] Next Step of Evolution: AngouriMath 2.0 #497 names, so when you fix something, ask what else is the same shape.
  • An unevaluated result and a NaN are different claims. Unevaluated means "I could not settle this"; NaN means "this does not exist". Returning NaN for a limit you merely failed to compute is a wrong answer, not a graceful failure. Right answer > no answer > slow answer > wrong answer.
  • Assert the mathematics, not the printed string — differentiate the integral back, substitute the root, subtract the identity. And reproduce on stock master before claiming something is broken.
  • Aim at the hard problems, and measure against a corpus, reporting wrong/error/timeout counts and not just how many were solved. A change that solves one more and gets one wrong is a regression.
  • Where to look things up: SymPy for reference implementations and cited papers, DLMF for special functions and branch cuts, Gruntz's thesis for limits, Bronstein for integration, ISSAC and JSC for what is new. Branch cuts get their own warning, since C99, .NET, Python and Mathematica do not all agree.
  • Branch first, always, with a stated naming scheme, even with write access.
  • Be concise, and keep wrong turns out of the code. Mistakes and retracted diagnoses belong in the issue tracker where they are searchable, not in commit messages or comments. What belongs in the code is the conclusion and the reason it holds.

It closes with the open issues worth starting on, grouped by depth, ending at the polynomial layer that most of the simplification and solving issues sit behind.

The per-push master feed goes; releases still publish to NuGet, which is the
only thing the workflow now does. The feed source comes out of NuGet.Config and
the badge table out of the README, so nothing points at a feed that will stop
being fed.
What an agent working here needs that CONTRIBUTING.md does not say: that
mathematical correctness outranks backward compatibility, that consistency is
the defect #497 names, that an unevaluated answer and a NaN are different
claims and only one of them is honest about failure, and that the mathematics
rather than the printed string is what a test should assert.

Also where to look things up, since these algorithms are decades of literature
deep and the good ones have names, and where the work is.
@codecov

codecov Bot commented Aug 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.59%. Comparing base (90c00a8) to head (8d0cad8).
⚠️ Report is 74 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #702      +/-   ##
==========================================
+ Coverage   80.99%   81.59%   +0.60%     
==========================================
  Files         155      157       +2     
  Lines       13687    13347     -340     
  Branches     1957     2198     +241     
==========================================
- Hits        11086    10891     -195     
+ Misses       1990     1849     -141     
+ Partials      611      607       -4     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Rafael-SOWNet
Rafael-SOWNet merged commit 0a5cdaf into ASC-Community:master Aug 4, 2026
26 checks passed
@Rafael-SOWNet
Rafael-SOWNet deleted the docs/agents-md branch August 4, 2026 20:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant