Skip to content

Commit cff2bb2

Browse files
authored
[MPT-20397] simplify AGENTS entrypoint guidance (#310)
## 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/swo-extension-playground#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 -->
2 parents acd48db + 0b9d309 commit cff2bb2

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
11
# AGENTS.md
22

3+
Working protocol for any task in this repository:
4+
5+
1. Identify the task type and select only the local repository files that are relevant to that task.
6+
2. Read only those relevant local files before making changes.
7+
3. If any selected local file references shared standards or shared operational guidance that are relevant to the same task, read those shared documents too before proceeding.
8+
4. Treat repository-local documents as repository-specific additions, restrictions, or overrides to shared guidance.
9+
5. If a repository-local rule conflicts with a shared rule, the local repository rule takes precedence.
10+
311
Python API client for the SoftwareONE Marketplace Platform (MPT) API. Provides synchronous
412
(`MPTClient`) and asynchronous (`AsyncMPTClient`) clients built on httpx, with typed
513
resource services, mixin-based HTTP operations, and an RQL query builder.
614

715
## Documentation Reading Order
816

17+
When applicable, read the repository documentation in this order:
18+
919
1. `README.md` — repository overview, quick start, and documentation map
1020
2. `docs/usage.md` — installation, configuration, Python usage examples, and supported Docker-based commands
1121
3. `docs/architecture.md` — layered architecture, directory structure, and key abstractions

0 commit comments

Comments
 (0)