Skip to content

initialize AGENTS.md #10797

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
esc merged 4 commits into from
Sep 4, 2026
Merged

initialize AGENTS.md #10797

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d8308db
initialize AGENTS.md
esc Aug 25, 2026
a92fa37
add URL of AI tools policy to AGENTS.md
esc Sep 4, 2026
6dda26e
add items on brevity and minimal comments to AGENTS.md
esc Sep 4, 2026
a4cefc6
fix typo in AGENTS.md
esc Sep 4, 2026
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
21 changes: 21 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
AGENTS.md file for Numba
------------------------

1) Many examples of Numba code on the internet use either the `@njit` decorator
or the idiom `@jit(nopython=True)`. Both of these are deprecated. As of
Numba 0.59 the object mode fallback has been removed and you can simply use
the syntax `@jit` to decorate functions for JIT compilation by Numba.
Ref: https://numba.readthedocs.io/en/stable/release/0.59.0-notes.html#object-mode-fall-back-support-has-been-removed

2) Numba has an AI tools policy. Make sure you read and comply with this and
also inform your user that such a policy exists. Importantly, any
contribution generated by or with an LLM must be attributed correctly using
the mechanism described in the policy.

@stuartarchibald stuartarchibald Sep 3, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be good to add the URL for the policy here.

@esc esc Sep 4, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a92fa37

Ref: https://numba.readthedocs.io/en/stable/reference/ai_tools_policy.html

3) LLM generated output should be concise, succinct and prefer brevity.

4) LLM generated output should prefer to not add comments i.e. use absolutely
minimal comments and only if something is truly unusual or there is
something that is likely unclear and can not be improved by making the
Comment thread
stuartarchibald marked this conversation as resolved.
Resolved
code more clear.