Skip to content

chore: KONFLUX-13929 add pattern references to AGENTS.md - #175

Open
vinashar-rh wants to merge 3 commits into
konflux-ci:mainfrom
vinashar-rh:konflux-13929-agentready-pattern-references
Open

chore: KONFLUX-13929 add pattern references to AGENTS.md#175
vinashar-rh wants to merge 3 commits into
konflux-ci:mainfrom
vinashar-rh:konflux-13929-agentready-pattern-references

Conversation

@vinashar-rh

Copy link
Copy Markdown

Summary

  • Add a Pattern References section to AGENTS.md pointing to real files for common change types (journey stage, CLI flag, error pattern, CSV logging)
  • Minimal fix for agentready Pattern References check (0/100 → 40/100 pass)

Test plan

  • uvx --from git+https://github.com/ambient-code/agentready agentready -- assess .pattern_references passes
  • AGENTS.md remains under 60 lines (47 lines)
  • PR CI passes

Made with Cursor

Document common change types with pointers to reference files so
agentready pattern_references check passes.

Co-authored-by: Cursor <cursoragent@cursor.com>
@jhutar

jhutar commented Sep 2, 2026

Copy link
Copy Markdown
Collaborator

/ok-to-test

Comment thread AGENTS.md Outdated
Comment on lines +30 to +33
- New journey stage: see `pkg/journey/handle_pipeline.go` for a reference implementation and `loadtest.go` for wiring into the journey
- New CLI flag: see `loadtest.go` and `pkg/options/options.go` for flag registration and options struct fields
- New error pattern: see `ci-scripts/config/errors.yaml` for YAML entry format
- CSV logging field: see `pkg/logging/time_and_log.go` for column names consumed by `evaluate.py`

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.

Given how the repo works (e.g. ci-scripts/config/errors.yaml is managed in different repo, this is just a downstream repo), I suggest these:

Suggested change
- New journey stage: see `pkg/journey/handle_pipeline.go` for a reference implementation and `loadtest.go` for wiring into the journey
- New CLI flag: see `loadtest.go` and `pkg/options/options.go` for flag registration and options struct fields
- New error pattern: see `ci-scripts/config/errors.yaml` for YAML entry format
- CSV logging field: see `pkg/logging/time_and_log.go` for column names consumed by `evaluate.py`
- New journey stage: see `pkg/journey/handle_pipeline.go` for a reference implementation and `loadtest.go` for wiring into the journey
- Resource create/delete lifecycle: create the resource in a journey handler under
`pkg/journey/` (e.g. `handle_releases_setup.go`, `handle_image_repository.go`) and mirror
the teardown in `handle_purge.go` `Purge()` so cleanup stays idempotent.
- Probe run scripts: shell logic lives in `ci-scripts/run-probe/` (`run.sh`,
`collect-results.sh`, `cluster_read_config.yaml`); mirror changes in the `run-ci/` /
`run-cluster/` variants.
- Horreum data scripts: scripts in `ci-scripts/utility_scripts/` (e.g.
`postgresql-backfill.sh`, `runs-to-csv.sh`) paired with schemas in
`ci-scripts/config/horreum-*.json`.

@vinashar-rh
vinashar-rh force-pushed the konflux-13929-agentready-pattern-references branch from 66973c9 to 5b1d0b0 Compare September 7, 2026 08:37
Vinayak Sharma and others added 2 commits September 7, 2026 14:20
Apply jhutar's suggested Pattern References bullets exactly as
provided in PR review.

Co-authored-by: Cursor <cursoragent@cursor.com>
Strip trailing spaces from pattern reference bullets so pre-commit
trim-trailing-whitespace passes in CI.

Co-authored-by: Cursor <cursoragent@cursor.com>
@vinashar-rh

Copy link
Copy Markdown
Author

@jhutar ok ,I implemented the recommended changes

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants