Skip to content

MPT-20397 simplify AGENTS entrypoint guidance - #47

Merged
d3rky merged 1 commit into
mainfrom
feature/MPT-20397/remove-redundant-start-with-agents-step
Apr 17, 2026
Merged

MPT-20397 simplify AGENTS entrypoint guidance#47
d3rky merged 1 commit into
mainfrom
feature/MPT-20397/remove-redundant-start-with-agents-step

Conversation

@d3rky

@d3rky d3rky commented Apr 17, 2026

Copy link
Copy Markdown
Contributor

🤖 AI-generated PR — Please review carefully.

Summary

  • replace the unconditional AGENTS.md entrypoint wording with a task-based protocol
  • make the repository reading order conditional on relevance to the current task
  • remove the redundant "Start with AGENTS.md" step from the local guidance

Testing

  • make build
  • make check-all
  • automatic pre-commit hooks on commit

Closes MPT-20397

  • Simplified AGENTS.md entrypoint guidance by removing the unconditional instruction to start by reading AGENTS.md itself
  • Made repository reading order conditional on task relevance, replacing "After you start with AGENTS.md..." phrasing with "When applicable" lead-in
  • Reordered initial protocol steps to prioritize task type identification and selection of relevant local files before repository documentation review

@coderabbitai

coderabbitai Bot commented Apr 17, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 409de918-4cda-4f21-b676-867fa98db89a

📥 Commits

Reviewing files that changed from the base of the PR and between da1e7f4 and 0527ef4.

📒 Files selected for processing (1)
  • AGENTS.md

📝 Walkthrough

Walkthrough

Updated AGENTS.md task workflow by removing the self-referential instruction to start with AGENTS.md itself, renumbering initial steps to begin with task identification, and restructuring phrasing with a new "When applicable" lead-in while preserving the subsequent repository-read sequence. Documentation-only change with no code logic modifications.

Changes

Cohort / File(s) Summary
Documentation task workflow
AGENTS.md
Reorganized task workflow instructions by removing explicit self-referential read order, renumbering steps to start with task type identification, and restructuring phrasing while maintaining the preserved reading sequence (README.md, docs/architecture.md, and subsequent docs).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • PR #43: Directly updates the AGENTS.md task workflow ordering and phrasing that is modified in this PR, sharing the same document changes.
  • PR #44: Modifies .github/copilot-instructions.md to reference AGENTS.md, which is the document being updated in this PR.
  • PR #46: Concurrently modifies AGENTS.md's documentation reading and workflow instructions in the same section as this PR.
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Jira Issue Key In Title ✅ Passed The PR title contains exactly one Jira issue key in the required format MPT-20397.
Test Coverage Required ✅ Passed PR modifies only AGENTS.md documentation file with no changes to Python code files in swo_playground/ or tests/ directories.
Single Commit Required ✅ Passed The PR contains exactly one commit (0527ef4) with focused documentation-only changes to AGENTS.md file.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

AI Generated.
Remove the redundant instruction to start with AGENTS.md and keep the task-based reading protocol focused on selecting relevant local files and applying the conditional repository reading order.
@d3rky
d3rky force-pushed the feature/MPT-20397/remove-redundant-start-with-agents-step branch from 9e5b1ca to 0527ef4 Compare April 17, 2026 14:41
@d3rky
d3rky marked this pull request as ready for review April 17, 2026 14:41
@d3rky
d3rky requested a review from a team as a code owner April 17, 2026 14:41
@d3rky
d3rky requested review from jentyk and robcsegal April 17, 2026 14:41
@sonarqubecloud

Copy link
Copy Markdown

@d3rky
d3rky merged commit 3a3357e into main Apr 17, 2026
4 checks passed
@d3rky
d3rky deleted the feature/MPT-20397/remove-redundant-start-with-agents-step branch April 17, 2026 14:52
d3rky added a commit to softwareone-platform/mpt-extension-sdk that referenced this pull request Apr 17, 2026
🤖 AI-generated PR — Please review carefully.

## Summary
- replace the unconditional AGENTS.md entrypoint wording with a
task-based protocol
- make the repository reading order conditional on relevance to the
current task
- align the local AGENTS.md guidance with the updated wording used in
`softwareone-platform/mpt-extension-python-template#47`

## Testing
- not run (documentation-only changes)

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

Closes [MPT-20397](https://softwareone.atlassian.net/browse/MPT-20397)

- Replaced unconditional "Read this repository in the following order"
instruction with a task-based working protocol
- Made repository reading sequence conditional on relevance to the
current task
- Expanded documentation reading order with additional files:
configuration, usage, local development, testing, contributing,
migrations, and documentation guides
- Aligned local AGENTS.md guidance with standards established in the
swo-extension-playground repository

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

[MPT-20397]:
https://softwareone.atlassian.net/browse/MPT-20397?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
d3rky added a commit to softwareone-platform/mpt-api-python-client that referenced this pull request Apr 17, 2026
## Summary
- adapt the AGENTS entrypoint guidance to a task-based working protocol
- make the repository documentation reading order conditional on task
relevance
- keep the local repository guidance focused on selecting only relevant
files before changes

## Testing
- not run (documentation-only change)

Closes [MPT-20397](https://softwareone.atlassian.net/browse/MPT-20397)

Source inspiration:
softwareone-platform/mpt-extension-python-template#47


[MPT-20397]:
https://softwareone.atlassian.net/browse/MPT-20397?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

Closes [MPT-20397](https://softwareone.atlassian.net/browse/MPT-20397)

- Simplify AGENTS entrypoint guidance with a task-based working protocol
- Add "Working protocol for any task" section with ordered steps for
selecting relevant local files, reading shared standards when
applicable, and applying precedence rules
- Make documentation reading order conditional on task relevance
- Extend documentation sequence with additional guides
(local-development.md, testing.md, contributing.md, documentation.md)

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant