Skip to content

Add AGENTS.md for better LLM use#22

Open
lurtz wants to merge 6 commits intoeclipse-score:mainfrom
elektrobit-contrib:add-agents-md-rust-cleanup
Open

Add AGENTS.md for better LLM use#22
lurtz wants to merge 6 commits intoeclipse-score:mainfrom
elektrobit-contrib:add-agents-md-rust-cleanup

Conversation

@lurtz
Copy link
Contributor

@lurtz lurtz commented Feb 16, 2026

AGENTS.md should make using LLMs more effective by requiring less manual fixes of the generate code.

AGENTS.md should make using LLMs more effective by requiring less manual fixes of the generate code.
@github-actions
Copy link

github-actions bot commented Feb 16, 2026

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run //:license-check

Status: ⚠️ Needs Review

Click to expand output
[License Check Output]
2026/02/17 12:07:58 Downloading https://releases.bazel.build/8.3.0/release/bazel-8.3.0-linux-x86_64...
Extracting Bazel installation...
Starting local Bazel server (8.3.0) and connecting to it...
INFO: Invocation ID: 1bd58382-2adc-49f8-a02a-32f4fa52d091
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
WARNING: For repository 'googletest', the root module requires module version googletest@1.17.0, but got googletest@1.17.0.bcr.2 in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 5 packages loaded
Loading: 5 packages loaded
    currently loading: 
Loading: 5 packages loaded
    currently loading: 
Loading: 5 packages loaded
    currently loading: 
Loading: 5 packages loaded
    currently loading: 
Analyzing: target //:license-check (6 packages loaded, 0 targets configured)
Analyzing: target //:license-check (6 packages loaded, 0 targets configured)

Analyzing: target //:license-check (24 packages loaded, 9 targets configured)

Analyzing: target //:license-check (91 packages loaded, 9 targets configured)

Analyzing: target //:license-check (100 packages loaded, 9 targets configured)

Analyzing: target //:license-check (152 packages loaded, 550 targets configured)

Analyzing: target //:license-check (170 packages loaded, 3858 targets configured)

Analyzing: target //:license-check (171 packages loaded, 5742 targets configured)

Analyzing: target //:license-check (175 packages loaded, 7550 targets configured)

Analyzing: target //:license-check (177 packages loaded, 7638 targets configured)

Analyzing: target //:license-check (177 packages loaded, 7638 targets configured)

Analyzing: target //:license-check (179 packages loaded, 8155 targets configured)

Analyzing: target //:license-check (181 packages loaded, 9769 targets configured)

Analyzing: target //:license-check (182 packages loaded, 9889 targets configured)

Analyzing: target //:license-check (182 packages loaded, 9889 targets configured)

Analyzing: target //:license-check (182 packages loaded, 9889 targets configured)

Analyzing: target //:license-check (182 packages loaded, 9889 targets configured)

Analyzing: target //:license-check (182 packages loaded, 9889 targets configured)

INFO: Analyzed target //:license-check (183 packages loaded, 11824 targets configured).
[9 / 13] [Prepa] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes
INFO: From Generating Dash formatted dependency file ...:
INFO: Successfully converted 2 packages from Cargo.lock to bazel-out/k8-fastbuild/bin/formatted.txt
[11 / 13] JavaToolchainCompileBootClasspath external/rules_java+/toolchains/platformclasspath.jar; 0s disk-cache, processwrapper-sandbox
[12 / 13] Building license.check.license_check.jar (); 0s disk-cache, multiplex-worker
INFO: Found 1 target...
Target //:license.check.license_check up-to-date:
  bazel-bin/license.check.license_check
  bazel-bin/license.check.license_check.jar
INFO: Elapsed time: 216.160s, Critical Path: 2.49s
INFO: 13 processes: 9 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 13 total actions
INFO: Running command line: bazel-bin/license.check.license_check ./formatted.txt <args omitted>
usage: org.eclipse.dash.licenses.cli.Main [-batch <int>] [-cd <url>]
       [-confidence <int>] [-ef <url>] [-excludeSources <sources>] [-help] [-lic
       <url>] [-project <shortname>] [-repo <url>] [-review] [-summary <file>]
       [-timeout <seconds>] [-token <token>]

@github-actions
Copy link

The created documentation from the pull request is available at: docu-html

@AlexanderLanin
Copy link
Member

Can you explain how to use this? AFAIK copilot will only pick up files like these automatically: https://github.com/eclipse-score/docs-as-code/tree/main/.github/instructions

@lurtz
Copy link
Contributor Author

lurtz commented Feb 16, 2026

Can you explain how to use this? AFAIK copilot will only pick up files like these automatically: https://github.com/eclipse-score/docs-as-code/tree/main/.github/instructions

The world is spinning really fast. Copilot got support for AGENTS.md:
https://github.blog/changelog/2025-08-28-copilot-coding-agent-now-supports-agents-md-custom-instructions/

The file was just created by typing /init Create a compact AGENTS.md. For new code tests should be added by default in the Chatwindow. I still have to learn what works and what does not.

@lurtz
Copy link
Contributor Author

lurtz commented Feb 16, 2026

This also states a top level AGENTS.md should work:
https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-repository-instructions?tool=vscode#creating-custom-instructions-1

@lurtz lurtz changed the title Add AGENTS.md for improved slopyness Add AGENTS.md for better LLM use Feb 16, 2026
@lurtz lurtz marked this pull request as ready for review February 16, 2026 13:36
AGENTS.md Outdated

The IPC boundary between gatewayd and someipd enforces **ASIL/QM context separation**—this is a critical architectural boundary. Changes affecting message transfer across this boundary require careful review.

**No direct ASIL/QM security features documented;** this is a QM-level project ([project_config.bzl](project_config.bzl)).
Copy link
Contributor

Choose a reason for hiding this comment

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

The gatewayd targets ASIL-B. Therefore the project is also ASIL-B, I guess?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have at the moment no idea how we deal with the situation that have both QM and ASIL-B in this repo. Anything related to vsomeip will be QM

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I removed this from the AGENTS.md file. I do not know what to do with project_config.bzl. This seems only to be required by Rust code and could get rid of it by removing the Rust code.

@lurtz lurtz force-pushed the add-agents-md-rust-cleanup branch from 8b03d56 to d22bd1e Compare February 17, 2026 12:07
@lurtz
Copy link
Contributor Author

lurtz commented Feb 17, 2026

Keep in mind there is some discussion in Slack about this PR and might be unlikely to be merged at the moment.

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.

3 participants