task: agent-ready prep - #379
jharlow-intel wants to merge 4 commits into
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
The documented lint setup is not executable as written, and two documentation nits remain unresolved.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
Documentation-only preparation for contributors, with no runtime, build, or packaging changes.
Changes:
- Adds contributor setup, testing, and workflow guidance.
- Adds a pull-request template.
- Links contributor guidance from
README.md. - Ignores local Claude Code settings.
File summaries
| File | Summary |
|---|---|
README.md |
Links to contributor guidance. |
CONTRIBUTING.md |
Documents development workflows and project structure. |
.gitignore |
Ignores local Claude settings. |
.github/pull_request_template.md |
Adds PR submission prompts and checklist. |
Review details
Suppressed comments (1)
CONTRIBUTING.md:19
- The documented lint command cannot run in the environment created here:
pre-commitis not installed by this command and is not part of the[test]extra. Add it to the environment (or document a separate install step) so the setup and checks are executable end to end.
meson-python ninja cmake cython pytest scipy mkl-service
- Files reviewed: 3/4 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| Each of these directories has an `AGENTS.md` stating the same boundaries for | ||
| coding agents; [`AGENTS.md`](AGENTS.md) at the root indexes them and is a useful | ||
| orientation map for humans too. |
| conda create -n mkl_fft-dev -c conda-forge python pip mkl-devel numpy \ | ||
| meson-python ninja cmake cython pytest scipy mkl-service |
There was a problem hiding this comment.
SciPy and mkl-service are technically optional dependencies, we can mention them below for using/testing the SciPy interface
| `clang-format`, `codespell`, `shellcheck`, `gitleaks`, and `actionlint`. Line | ||
| length is 80 for Python, Cython, and TOML. | ||
|
|
||
| ### What CI runs |
There was a problem hiding this comment.
I feel like this section can be more brief/concise, I'm not sure it's necessary for an external user to be subject to the particulars of the CI. For example, NumPy is very brief in its contributing document in discussing the CI, noting "various checks" and not much else.
| (or `conda-recipe-cf` for the conda-forge variant). The recipe directories are | ||
| canonical for packaging intent and dependency pins. | ||
|
|
||
| ## How the code fits together |
There was a problem hiding this comment.
I also feel this section doesn't exactly belong, if anything a style guide would make more sense (though we are pretty loose with the style).
ndgrigorian
left a comment
ndgrigorian
left a comment
There was a problem hiding this comment.
Frankly I have no issue with anything in this PR besides those nits in the contributing document, LGTM
Description
Adds
CONTRIBUTING.mdand a pull-request template, gitignores developer-localClaude Code settings, and links CONTRIBUTING from the README.
Prompted by an AgentReady readiness scan, which flagged the missing developer
docs and PR template as its only findings (96/100 → 100/100).
Verification
pytest mkl_fft/tests— 971 passed, 2 skipped (Python 3.12,NumPy 2.5.3, Linux). The setup steps in th
end to end:
conda create,pip install -e ".[test]" --no-build-isolation,and the
rm -rf build+ reinstall recovery path.pre-commit run --files CONTRIBUTING.md README.md .gitignore .github/pull_request_template.md— all apChecklist
mkl_fft/tests/; bug fixes have a regression test.