Conversation
There was a problem hiding this comment.
Pull request overview
Updates contributor/agent documentation and Copilot prompt assets to standardize local validation and routine workflows around the repo’s root Makefile, and introduces specialist routing prompts for strategy vs search/API topics.
Changes:
- Replace raw
pytest/ruff/mypycommand examples withmaketargets across README/CONTRIBUTING/agent docs/prompts. - Add specialist domain docs + Copilot specialist prompt files and document topic-routing rules.
- Expand “common make targets” guidance in end-user and agent-facing docs.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/strategy/AGENT.md | Adds “Validation Workflow” section pointing to Makefile targets. |
| docs/search-api/AGENT.md | Adds “Validation Workflow” section pointing to Makefile targets. |
| README.md | Switches run/test/lint/typecheck examples to Makefile targets and adds a “Common Make Targets” section. |
| CONTRIBUTING.md | Replaces manual lint/typecheck/test commands with make check guidance. |
| CLAUDE.md | Updates post-change workflow to make check and documents Makefile target preferences + routing. |
| AGENTS.md | Registers new specialist docs/prompts and updates pre-push test guidance wording. |
| .github/prompts/write-tests.prompt.md | Updates test-running instruction to prefer make test. |
| .github/prompts/pr-review.prompt.md | Updates “run the check suite” step to make check. |
| .github/prompts/new-pydantic-model.prompt.md | Adds make check validation instruction. |
| .github/prompts/new-db-function.prompt.md | Adds make check validation instruction. |
| .github/copilot/strategy-specialist.prompt.md | New Copilot specialist-mode prompt for strategy context. |
| .github/copilot/search-api-specialist.prompt.md | New Copilot specialist-mode prompt for search/API context. |
| .github/copilot-instructions.md | Switches to make check and adds topic-routing guidance for Copilot Chat. |
Comments suppressed due to low confidence (8)
.github/copilot-instructions.md:50
- The topic-routing sub-bullets are tab-indented. Please switch to spaces for the nested list indentation so Markdown renders consistently (tabs can appear mis-indented depending on viewer/editor).
- **Search/API/provider topics** (keywords like: API, search, provider, Bundesagentur, SerpApi, query quality, stale jobs)
- First consult: `docs/search-api/AGENT.md`
- Then use supporting context from: `docs/search-api/Improving Job Search API Results.md` and `AGENTS.md`
- **Strategy/roadmap/market topics** (keywords like: strategy, roadmap, prioritization, launch, monetization, pricing, market)
- First consult: `docs/strategy/AGENT.md`
- Then use supporting context from: `docs/strategy/ROADMAP.md` and `AGENTS.md`
docs/strategy/AGENT.md:26
- The nested list under “Validation Workflow” uses tab indentation. GitHub Markdown rendering is more reliable with spaces; please replace the tab-indented sub-bullets with space indentation to avoid inconsistent rendering across viewers/editors.
- Prefer Makefile targets for any implementation follow-through:
- `make check` (full gate)
- `make test` (tests)
- `make lint` (ruff)
- `make typecheck` (mypy)
docs/search-api/AGENT.md:32
- The nested list under “Validation Workflow” uses tab indentation. Please use spaces for the sub-bullets to keep Markdown rendering consistent (tabs can render inconsistently).
- Prefer Makefile targets for checks:
- `make check` (full gate)
- `make test` (tests)
- `make lint` (ruff)
- `make typecheck` (mypy)
README.md:62
- The README describes
make lintas “ruff lint/format check”, but the current Makefilelinttarget only runsruff check --fix(no format check) and it auto-fixes. Update the description (and/or add a separatemake format --check/adjustmake lint) so the documented behavior matches what actually runs.
make check # full gate (tests + lint + format + mypy)
make test # tests only
make lint # ruff lint/format check
make typecheck # mypy
make coverage # pytest coverage report
CLAUDE.md:16
make checkis shown as the default post-change command, but the file still says the venv activation is “ALWAYS required before any command”. Since the Makefile targets alreadysource .venv/bin/activate, please clarify this section (e.g., “activate venv for direct commands; Make targets handle it”) to avoid contradictory guidance.
## After every code change — run automatically, don't ask
```bash
make check
**CLAUDE.md:22**
* This list says `make lint` does a “ruff lint/format check”, but the Makefile `lint` target currently only runs `ruff check --fix` (no format check) and it auto-fixes. Please update the wording here to match the actual target behavior (or adjust the Makefile targets accordingly).
Prefer Makefile targets for daily workflow:
make check(full gate)make test(tests only)make lint(ruff lint/format check)make typecheck(mypy)
**AGENTS.md:630**
* The on-push hook is documented as `make test` / `pytest ... --tb=short`, but `make test` currently runs `pytest tests/ -x -q` (no `--tb=short`) while the actual pre-push hook entry uses `.venv/bin/pytest ... --tb=short`. Please adjust this line so it accurately reflects what runs on pre-push (and/or align `make test` with the pre-push args).
- On commit: trailing whitespace, YAML/TOML/JSON checks, large file check, merge conflict detection, private key detection, secrets scanning, ruff lint+format, mypy
- On push: full test suite (
make test/pytest tests/ -x -q --tb=short)
**.github/copilot/search-api-specialist.prompt.md:13**
* This file uses a tab-indented list item under “defaulting to:”. Please replace the tab with spaces so the Markdown list formatting is consistent and renders reliably.
- For implementation tasks, validate with Makefile targets, defaulting to:
make check
</details>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.