FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Add AI assistant instruction file (agents.md) for Copilot, Claude, and JetBrains Junie by Copilot · Pull Request #3176 · fluentassertions/fluentassertions · GitHub

/ fluentassertions Public

Add AI assistant instruction file (agents.md) for Copilot, Claude, and JetBrains Junie - #3176

Merged
dennisdoomen merged 5 commits into
mainfrom
copilot/generate-ai-instructions
Mar 23, 2026
ConversationCommits (5)ChecksFiles changed
Merged

Add AI assistant instruction file (agents.md) for Copilot, Claude, and JetBrains Junie#3176
dennisdoomen merged 5 commits into
mainfrom
copilot/generate-ai-instructions

Conversation

Copilot AI commented Mar 8, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor
  • Create agents.md at the repo root as the single source of truth for AI assistant guidelines
  • Replace .github/copilot-instructions.md with a pointer to agents.md
  • Replace CLAUDE.md with @agents.md (Claude's native import syntax)
  • Replace .junie/guidelines.md with a pointer to agents.md
  • Use fact-based test method names (e.g. Succeeds_for_*, The_X_must_be_Y, An_X_is_required) – avoid "Should", "When", and "Asserting"
  • Target the main branch for pull requests
  • Assertion methods return AndConstraint<TAssertions> or AndWhichConstraint<TAssertions, T>
  • Source lives in Src/FluentAssertions/; tests in Tests/FluentAssertions.Specs/ and Tests/FluentAssertions.Equivalency.Specs/

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Add AI instruction files for Copilot, Claude, and JetBrains Junie
2fcedf7 
Co-authored-by: dennisdoomen <572734+dennisdoomen@users.noreply.github.com>
Copilot AI changed the title [WIP] Add AI instructions for Copilot, Claude, and Junie Add AI assistant instruction files for Copilot, Claude, and JetBrains Junie Mar 8, 2026
dennisdoomen requested changes Mar 8, 2026
View reviewed changes
Comment thread .github/copilot-instructions.md Outdated
}
```

- Test method names use `Succeeds_for_*` and `Fails_for_*` – avoid "Should", "When", and "Asserting"

dennisdoomen Mar 8, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

No, please use fact-based names without using words like "should", "when" and "asserting". Use InlineAssertionsSpecs as reference.

Also update the other instructions files

Copilot AI Mar 8, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Updated all three instruction files in 84856fc. The test example now shows The_foo_must_satisfy_some_condition (fact statement) instead of Fails_for_foo_with_unexpected_value, and the naming guidance now reads: "Use fact-based test method names (e.g. Succeeds_for_*, The_X_must_be_Y, An_X_is_required) – avoid 'Should', 'When', and 'Asserting'", modelled on InlineAssertionsSpecs.

Use fact-based test method names in AI instruction examples
84856fc 
Co-authored-by: dennisdoomen <572734+dennisdoomen@users.noreply.github.com>
jnyrup reviewed Mar 8, 2026
View reviewed changes

jnyrup left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Great!

I was just beginning to think we needed such files to avoid having to repeat to AI agents that we they need to update the api snapshot and use the new naming conventions for test methods.

Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
Comment thread .junie/guidelines.md Outdated
Comment thread CLAUDE.md Outdated
Comment thread .junie/guidelines.md Outdated
Comment thread .junie/guidelines.md Outdated
Comment thread CLAUDE.md Outdated
Comment thread CLAUDE.md Outdated

dennisdoomen commented Mar 9, 2026

Copy link
Copy Markdown
Member

Great!

I was just beginning to think we needed such files to avoid having to repeat to AI agents that we they need to update the api snapshot and use the new naming conventions for test methods.

@copilot please address all comments

Address review feedback: main branch, AndWhichConstraint, Equivalency…
ba6724e 
….Specs

Co-authored-by: dennisdoomen <572734+dennisdoomen@users.noreply.github.com>

dennisdoomen commented Mar 23, 2026

Copy link
Copy Markdown
Member

@copilot Can't we just use a single Agents.md file instead?

Copilot AI commented Mar 23, 2026

Copy link
Copy Markdown
Contributor Author

@copilot Can't we just use a single Agents.md file instead?

Each tool reads from its own specific hardcoded path — Copilot reads .github/copilot-instructions.md, Claude reads CLAUDE.md, and Junie reads .junie/guidelines.md. None of them look for a generic Agents.md, so a single file wouldn't be picked up automatically by any of them.

If you'd like to reduce duplication, one option is to keep a canonical Agents.md with the shared content and have the three tool-specific files contain just a brief pointer to it. But all three files would still need to exist at their expected paths. Would you like me to go that route, or keep the three self-contained files as they are?

Copilot AI requested a review from dennisdoomen March 23, 2026 17:30

dennisdoomen commented Mar 23, 2026

Copy link
Copy Markdown
Member

@copilot Merge the three files into a single agents.md in the root of the repo

Copilot AI commented Mar 23, 2026

Copy link
Copy Markdown
Contributor Author

@copilot Merge the three files into a single agents.md in the root of the repo

Done in 383a078. All the content is now in a single agents.md at the repo root. Each tool-specific file is a one-liner pointing to it:

  • CLAUDE.md → @agents.md (Claude's native import syntax)
  • .github/copilot-instructions.md → markdown link to agents.md
  • .junie/guidelines.md → markdown link to agents.md

Copilot AI changed the title Add AI assistant instruction files for Copilot, Claude, and JetBrains Junie Add AI assistant instruction file (agents.md) for Copilot, Claude, and JetBrains Junie Mar 23, 2026
dennisdoomen marked this pull request as ready for review March 23, 2026 17:46
dennisdoomen requested a review from jnyrup March 23, 2026 17:46
This was referenced Aug 24, 2026
Open
Open
Open
Open
Open
Open
Open
Open
Closed
Closed
Open
Open
Open
Open
Open
Closed
Open
Open
Open
Closed
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

jnyrup jnyrup approved these changes
+1 more reviewer
dennisdoomen dennisdoomen approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

dennisdoomen

Copilot code review Copilot

Labels

building Building and Infrastructure of Fluent Assertions

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

Back | FazBrowse Home | New Git URL