Sharpmake
AGENTS.md1.1k starsChanged 3 months agoApache-2.0View on GitHub
Trending
Quiet this year.thin dataabout the whole repository
Who's talking about ubisoft/Sharpmake
- GPUOpen-LibrariesAndSDKs/RenderPipelineShaders“Cleanup the same filename stem for `rps_rpsl_host`”GitHub · Apr 6, 2023
- GPUOpen-LibrariesAndSDKs/RenderPipelineShaders“Same filename stem for `rps_rpsl_host` leads to possible obj-output overwrite and it will slow compile/link …”GitHub · Apr 6, 2023
- Stack Overflow“Should Qt track changes in resource at build time?”Stack Overflow · Sep 13, 2021
- ossf/scorecard“BUG: Parsing errors”GitHub · Aug 11, 2021
The biggest 4 of 4 mentions linking to the repository that our crawl found. Each line is their own headline.
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,774 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repositoryOne other file it gives its agents.
- CLAUDE.mdCLAUDE.md
The file
We split this AGENTS.md into the rules it gives an agent
3 rules. About 0 are common, 2 are distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
Distinctive · estimate
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- could be automatic: a setting could enforce it
- Distinctive: line 2
Use TDD when making changes in this repo.
- Distinctive: line 3
Run the full test suite before declaring a task done.
- Very specific: line 6
Default configuration is Release.
≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Collaboration guidelines
- Use TDD when making changes in this repo.
- Run the full test suite before declaring a task done.
Build & test
- Default configuration is Release; Debug is also allowed (
-c Debug). - Build:
dotnet build Sharpmake.sln /p:Configuration=Release /p:Platform="Any CPU" - Unit tests (NUnit):
dotnet test Sharpmake.UnitTests -c Release - Public API tests:
dotnet test Sharpmake.PublicApiTests -c Release - Regression tests (compare samples output to reference):
python regression_test.pyafter building
Generated outputs (don't hand-edit)
- Samples reference output: regenerate with
UpdateSamplesOutput.bat - Verified public API snapshot: regenerate with
UpdateVerifiedPublicApi.batwhen the public API intentionally changes
Layout
Sharpmake/: core,Sharpmake.Generators/: generators,Sharpmake.Platforms/: platformsSharpmake.Application/: entry point,samples/: sample definitions,docs/: documentation- Adding a sample: see
docs/Samples.md
Further reading (only when relevant)
- Writing or changing Sharpmake definitions (targets, projects, samples): read
docs/Guidelines.md. - Adding a platform or changing test/reference-output workflow: read
CONTRIBUTING.md.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.