Conversation
|
where is AGENTS_DETAILED.md recommended? |
|
@bishabosha recommended? |
Gedochao
force-pushed
the
dx/contributions-agents
branch
from
9fb74e2 to
d1207ba
Compare
|
my thought was that AGENTS.md is hardcoded to be used as context by those agents that support it, so it isnt useful to have a separate file that they arent looking for, perhaps im wrong. |
Gedochao
force-pushed
the
dx/contributions-agents
branch
from
d1207ba to
a29ee32
Compare
Gedochao
force-pushed
the
dx/contributions-agents
branch
from
a29ee32 to
7c4f130
Compare
|
After some experiments and research, it seems it will still be handled better by many tools to just have a single file. |
|
Let agents fix all the issues:) |
If only it were that simple. 😅 |
|
|
||
| Read these for broader context; do not duplicate their content in your PRs: | ||
|
|
||
| - **[DEV.md](DEV.md)** — Developer setup, how to run the CLI from sources, run tests, generate launchers, IDE import, |
|
|
||
| - **[DEV.md](DEV.md)** — Developer setup, how to run the CLI from sources, run tests, generate launchers, IDE import, | ||
| GraalVM reflection config, and more. | ||
| - **[CONTRIBUTING.md](CONTRIBUTING.md)** — Fork-pull workflow, branch strategy (`main` for code, `stable` for |
There was a problem hiding this comment.
Does it not contain too much data for LLMs? If we create a skill in theory we could split the data to be loaded more lazily
| ```bash | ||
| ./mill -i scala …args… # Run Scala CLI from source | ||
| ./mill -i __.compile # Compile everything | ||
| ./mill -i unitTests # All unit tests |
There was a problem hiding this comment.
Maybe add how to run a single test?
| Unit tests live inside individual modules as `test` submodules. The test framework is **munit**. | ||
|
|
||
| ```bash | ||
| ./mill -i 'build-module[].test' # All build-module tests |
There was a problem hiding this comment.
I don't think we should repeat it, we already have some commands defined above. We should merge both
| tests live in `modules/cli/src/test/scala/`. Only reach for integration tests when a unit test cannot cover the | ||
| scenario. | ||
|
|
||
| ### Integration tests |
There was a problem hiding this comment.
Should the agents/md be that long? Are we doing too much context? Could we skip the additional stuff below?
I think there was a discusion that Agends.md being long was not helpful. I would limit it to how to run test and maybe what each module is. We can use more hierachical structure like skills for more context
4 participants
Some context for speeding up agents, encouraging certain behaviours and such.
Requires/includes:
Checklist
scala-cli fmt .)scalafix(./mill -i __.fix)./mill -i 'generate-reference-doc[]'.run)How much have your relied on LLM-based tools in this contribution?
extensively, this is made by agents for agents, purely vibe coded metaprompting ™️
used Cursor with Claude
How was the solution tested?
I use this as context for agents when working with this repo and it works reasonably well
Additional notes
A similar file in the Scala 3 repo (without the detailed one)
https://github.com/scala/scala3/blob/main/AGENTS.md