Agents.md for AI Agents

[memodi]

Description

Agents.md could be useful to provide context about network-observability operator repo to build, test, document new features or answer questions about existing features.

Dependencies

n/a

Checklist

If you are not familiar with our processes or don't know what to answer in the list below, let us know in a comment: the maintainers will take care of that.

• Is this PR backed with a JIRA ticket? If so, make sure it is written as a title prefix (in general, PRs affecting the NetObserv/Network Observability product should be backed with a JIRA ticket - especially if they bring user facing changes).
• Does this PR require product documentation?
  • If so, make sure the JIRA epic is labeled with "documentation" and provides a description relevant for doc writers, such as use cases or scenarios. Any required step to activate or configure the feature should be documented there, such as new CRD knobs.
• Does this PR require a product release notes entry?
  • If so, fill in "Release Note Text" in the JIRA.
• Is there anything else the QE team should know before testing? E.g: configuration changes, environment setup, etc.
  • If so, make sure it is described in the JIRA ticket.
• QE requirements (check 1 from the list):
  • Standard QE validation, with pre-merge tests unless stated otherwise.
  • Regression tests only (e.g. refactoring with no user-facing change).
  • No QE (e.g. trivial change with high reviewer's confidence, or per agreement with the QE team).

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 72.46%. Comparing base (9d6ffed) to head (a397327).
⚠️ Report is 21 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2272      +/-   ##
==========================================
- Coverage   72.68%   72.46%   -0.23%     
==========================================
  Files          88       88              
  Lines        9677     9677              
==========================================
- Hits         7034     7012      -22     
- Misses       2209     2223      +14     
- Partials      434      442       +8     

Flag	Coverage Δ
unittests	72.46% <ø> (-0.23%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 6 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[nathan-weinberg]

A brave new world!

[openshift-ci]

@nathan-weinberg: changing LGTM is restricted to collaborators

Details

In response to this:

A brave new world!

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[jpinsonneau]

Looks good for a first implementation.

Have you tried it ? Do you see improvements ?

[openshift-ci]

New changes are detected. LGTM label has been removed.

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from jpinsonneau. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

• DOWNSTREAM_OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[stleerh]

The challenge is keeping this document up-to-date. I know it's like a README.md for AI agents, but it's quite detailed, so it's easy for this to get outdated. The more it can reference the actual files themselves to get the information, the better.

[memodi]

The challenge is keeping this document up-to-date. I know it's like a README.md for AI agents, but it's quite detailed, so it's easy for this to get outdated.

@stleerh
indeed, it's one additional file to maintain besides README.md, however it's not as cumbersome to keep it updated, since you can ask Claude to update it and we can simply verify newer changes. The recommended number of lines for Agents.md is < 400 to provide sufficient context and optimize the token usage.

The more it can reference the actual files themselves to get the information, the better.

100%, in this PR it uses actual files wherever possible for e.g.: sections like "Key Files" and "Resources" sections.

[memodi]

Have you tried it ? Do you see improvements ?

@jpinsonneau - I haven't tried specifically to perform code changes in Operator repo but I tried for Review since I have below context what to "Review" for, it'd ensure below areas it would evaluate code changes for, whether or not its assessment is actually accurate that's for human behind invoking has to decide 🙃

1. Code style consistency
2. Error handling (wrap with context)
3. Unit test coverage (Ginkgo/Gomega)
4. CRD validation markers
5. Documentation updates
6. Backward compatibility
7. Security (RBAC, TLS, input validation)
8. Performance and Resource utilization, including watching for memory usage impact for large scale clusters.

[openshift-ci]

@memodi: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/e2e-operator	149a653	link	false	/test e2e-operator

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.