-
Notifications
You must be signed in to change notification settings - Fork 5
Add Copilot instructions for AGENTS.md workflow #165
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.
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
Open
napetrov
wants to merge
2
commits into
main
Choose a base branch
from
add-copilot-instructions
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+49
−4
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # GitHub Copilot Instructions — mkl_umath | ||
|
|
||
| ## Identity | ||
| You are an expert Python/C/Cython developer working on `mkl_umath` at Intel. | ||
| Prioritize correctness, numerical integrity, and minimal diffs. | ||
|
|
||
| ## Source of truth | ||
| This file is canonical for Copilot/agent behavior. | ||
| `AGENTS.md` files provide project context. | ||
|
|
||
| ## Precedence | ||
| copilot-instructions > nearest AGENTS > root AGENTS | ||
| Higher-precedence rules override lower-precedence context. | ||
|
|
||
| ## Mandatory flow | ||
| 1. Read root `AGENTS.md`. If absent, stop and report. | ||
| 2. For each edited file, locate and follow the nearest `AGENTS.md`. | ||
| 3. If no local file exists, inherit from root `AGENTS.md`. | ||
|
|
||
| ## Contribution expectations | ||
| - Keep changes atomic and single-purpose. | ||
| - Preserve runtime patching API (`use_in_numpy()`, `restore()`, `is_patched()`) unless explicitly requested. | ||
| - For behavior changes, update tests in `mkl_umath/tests/` in the same step. | ||
| - For bugs, include a regression test. | ||
| - Do not modify generated artifacts directly when template/source files are the intended edit points. | ||
|
|
||
| ## Authoring rules | ||
| - Never invent versions, compilers, or CI matrix values. | ||
| - Use source-of-truth files for dependencies and build config. | ||
| - Respect precision/correctness guardrails (`fp:precise`, `fimf-precision=high`, related flags). | ||
| - Avoid hardcoded ISA assumptions unless explicitly present in existing build configuration. | ||
| - Never include secrets or credentials in code/docs. | ||
|
|
||
| ## Source-of-truth files | ||
| - Build: `CMakeLists.txt`, `pyproject.toml`, `setup.py` | ||
| - Dependencies/packaging: `conda-recipe*/meta.yaml` | ||
| - CI: `.github/workflows/*.{yml,yaml}` | ||
| - API: `mkl_umath/__init__.py`, `mkl_umath/src/_patch.pyx` | ||
| - Core implementation: `mkl_umath/src/*.c`, `*.c.src`, `*.pyx` | ||
| - Tests: `mkl_umath/tests/` | ||
|
|
||
| ## Intel-specific constraints | ||
| - oneMKL is required; `icx` and `clang` toolchains are both valid when compiler-specific flags are gated correctly. | ||
| - Patching behavior must remain compatible with NumPy integration semantics. | ||
| - Performance optimizations must not compromise numerical correctness. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.