Skip to content

chore: include agents md - #5413

Open
prmukherj wants to merge 9 commits into
mainfrom
feat/include_agents_md
Open

prmukherj wants to merge 9 commits into
mainfrom
feat/include_agents_md

Conversation

@prmukherj

@prmukherj prmukherj commented Sep 24, 2026 •

Copy link
Copy Markdown
Collaborator

Context

Add repository-specific agent guidance to improve accuracy and reduce unnecessary context loading, aligned with PyFluent’s restructured layout.

Change Summary

  1. Establish AGENTS.md as the canonical setup, repository map, and operating guide.
  2. Add detailed architecture and orchestration diagrams, source-owner mappings, feature-to-test routes, and contributor workflows under agents.
  3. Document test prerequisites, version/mode filtering, cheap validation targets, generated-code boundaries, and destructive-command warnings.
  4. Keep copilot-instructions.md as a minimal pointer.
  5. Require root-cause fixes, standard software design principles, and user approval for future guidance changes.

Rationale

  1. Use concise startup instructions with on-demand detail to help agents locate the right implementation and tests without scanning the entire repository.
  2. Preserve unique facts and safety rules while consolidating duplication.

Impact

Documentation only; no runtime behavior changes.

@ansys-cla-bot

ansys-cla-bot Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

The following people have not signed the Contributors License Agreement (CLA):

Read the CLA in the link above and sign it by clicking below:

You will receive a confirmation as soon as your signature is captured.

Note

Action Required: Repository maintainers with write access can trigger a recheck by commenting
@cla-bot rerun
Please contact the maintainers to rerun the CLA check after the missing signatures have been captured.

@github-actions github-actions Bot added maintenance General maintenance of the repo (libraries, cicd, etc) CI/CD new feature labels Sep 24, 2026
@codacy-production

codacy-production Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

Not up to standards ⛔

🔴 Issues 50 minor

Alerts:
⚠ 50 issues (≤ 0 issues of at least minor severity)

Results:
50 new issues

Category Results
CodeStyle 50 minor

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@prmukherj prmukherj changed the title Feat/include agents md feat: include agents md Sep 24, 2026
@prmukherj
prmukherj marked this pull request as ready for review October 2, 2026 15:51
@seanpearsonuk

Copy link
Copy Markdown
Collaborator

This probably should have been maint or chore or whatever we settled on, given that it isn't adding anything functionally.

@prmukherj prmukherj changed the title feat: include agents md chore: include agents md Oct 5, 2026
@prmukherj

Copy link
Copy Markdown
Collaborator Author

This probably should have been maint or chore or whatever we settled on, given that it isn't adding anything functionally.

Right @seanpearsonuk. This should be chore.

@github-actions github-actions Bot added the enhancement Improve any current implemented feature label Oct 5, 2026
transfer["connectivity: file/data transfer strategies"] -.-> sessions
transfer -.-> files
```

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.

  • Each bullet below mixes multiple, unrelated concerns, which we don't want.
  • I can figure out the meanings of things only due to my PyFluent experience.
  • Fields, a namespace, is used in the plural, so the context might easily be misinterpreted.
  • Fields is defined by negation. A simpler definition is possible.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I have refactored a bit here. The primary thing missing here was that it was not using code namespaces and thus would have wasted credits. That has been updated now.

Regarding the last point, I have updated it in this case, but in some instances a negation might be good idea to suggest agent what not to look for in a particular case.

Pleas have a look into the updated file.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI/CD enhancement Improve any current implemented feature maintenance General maintenance of the repo (libraries, cicd, etc) new feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants