Skip to content

Add AGENTS.md with service context and repository guidelines - #710

Open
Pasarus wants to merge 3 commits into
mainfrom
add_agents_md
Open

Pasarus wants to merge 3 commits into
mainfrom
add_agents_md

Conversation

@Pasarus

@Pasarus Pasarus commented Oct 26, 2026 •

Copy link
Copy Markdown
Member

Part of https://github.com/fiaisis/planning/issues/43

Description

Add AGENTS.md documenting fia-api's position within the overall FIA service architecture (overarching pipeline map and upstream/downstream/sibling repository contracts), directory-level repository structure, pyproject.toml and environment conventions, testing/linting requirements, issue and PR workflows, and Dependabot handling.

@Pasarus Pasarus added the AI Created with the assistance of AI label Oct 26, 2026
@codecov

codecov Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.04%. Comparing base (481ed2a) to head (cef8e0d).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #710   +/-   ##
=======================================
  Coverage   97.04%   97.04%           
=======================================
  Files          50       50           
  Lines        2335     2335           
=======================================
  Hits         2266     2266           
  Misses         69       69           

☔ 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.

@eva-1729 eva-1729 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I asked some advice from Copilot on this (it seemed relevant as it is an agent) and it suggested having a specific "must follow" area, vs. general guidance. Is that possible to consider with this?

@Pasarus

Pasarus commented Oct 27, 2026

Copy link
Copy Markdown
Member Author

The way I see it the whole thing is general guidance and anything that is a MUST, has the word must in as part of the overall guidance. i.e. general unless otherwise stated.

@eva-1729

Copy link
Copy Markdown
Collaborator

Okay that makes sense to me; this one covers quite a lot so it would be hard to break things out into a specific section that applies to all of it anyway

@eva-1729

Copy link
Copy Markdown
Collaborator

Another thought: there doesn't seem to be any mention of perhaps a line where, at some point, the agent would need to hand over to a person. It might be good to outline this sort of boundary.

@Pasarus

Pasarus commented Oct 28, 2026

Copy link
Copy Markdown
Member Author

So in some parts I do say when to hand back to a person, for example with regards to information that is not trivially accessible. i.e. issue number for the pull request. Where do you think we should add more?

…t-lsp

FIA-API now fronts `POST /script/analyse` for the script editors, which makes
mantid-python-script-lsp a downstream dependency with a wire contract that lives
in two repositories at once. Record it where an agent changing either side will
meet it: the pass-through rule, why the byte-based size cap has to be agreed
between the two services, and why a cache hit has to carry the caller's own
`content_hash` rather than the one stored.
…stion

The instruction described the label as something to attach, and named two label
spellings to look for, which reads like a judgement call left for whoever opens
the PR. Name the label, the command, and the moment it happens.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AI Created with the assistance of AI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants