add-feature
Skill90 starsChanged 3 months agoApache-2.0View on GitHub
Checklist for adding new physics or features to Breeze
27 other projects use a version of this, 1 of them edited.
Adopted by
Most recently taken up by
- NVIDIA/nvcftheir own version, first seen Nov 15, 2026
- SHREESHMAN/lineupifytheir own version, first seen Nov 15, 2026
- subhashkhileri/agntreetheir own version, first seen Oct 25, 2026
- WhatIfWeDigDeeper/claude-code-courseratheir own version, first seen Oct 20, 2026
- CliMA/Oceananigans.jledited, first seen Oct 17, 2026
- PopKult/claude-skillstheir own version, first seen Oct 15, 2026
Other versions27 projects use a version of this.
Word for word · 0
None found.
Edited · 1
- CliMA/Oceananigans.jl★ 1.4k65% same
Wrote their own version · 26
- fullstackhero/dotnet-starter-kit★ 6.9ksame name
- JamieMason/syncpack★ 2.1ksame name
- OpusGameLabs/game-creator★ 360same name
- microsoft/SqlScriptDOM★ 284same name
- NVIDIA/nvcf★ 268same name
- nikandr-surkov/ai-saas-starter★ 16same name
- Azure/azure-functions-agents-runtime★ 13same name
- aiqadam/qadam-flow★ 5same name
- subhashkhileri/agntree★ 5same name
- rsml/tutor★ 4same name
16 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository6 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- babysit-ciSkill
- build-docsSkill
- new-simulationSkill
- run-testsSkill
The file
We split this skill into the rules it gives an agent
9 rules. 0 are common, 2 are distinctive, and 7 are very specific to this project.
0
Common
Most of the 25 edited versions we read keep these.
2
Distinctive
This author's own choices. Worth a look.
7
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 8
Follow this checklist when adding new physics or features to Breeze.
- Very specific: line 14
All structs concretely typed.
- Very specific: line 15
Use materialization pattern: skeleton struct → materialize_* for fully-typed version
- Very specific: line 17
Use @kernel and @index from KernelAbstractions.jl
- Distinctive: line 18
Keep type-stable and allocation-free
- Very specific: line 19
Use ifelse instead of short-circuiting if/else
- Very specific: line 21
No loops over grid points outside kernels — use launch!
- Very specific: line 25
Verify on CPU: Run tests with ENV["CUDA_VISIBLE_DEVICES"] = "-1"
- Very specific: line 26
Check explicit imports: Run quality_assurance test
“Common” is measured: kept by at least 6 in 10 of the 25 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Add Feature
Follow this checklist when adding new physics or features to Breeze.
Checklist
- Create module in the appropriate subdirectory under
src/ - Define types/structs with docstrings (use
jldoctestblocks, never plainjulia)- All structs concretely typed. Never use
Anyas a type parameter. - Use materialization pattern: skeleton struct →
materialize_*for fully-typed version
- All structs concretely typed. Never use
- Implement kernel functions — must be GPU-compatible:
- Use
@kerneland@indexfrom KernelAbstractions.jl - Keep type-stable and allocation-free
- Use
ifelseinstead of short-circuitingif/else - Mark inner functions with
@inline - No loops over grid points outside kernels — use
launch!
- Use
- Add unit tests in
test/(ParallelTestRunner autodiscovery will find them) - Update exports in
src/Breeze.jlif the user interface changed - Add validation example in
examples/when appropriate - Verify on CPU: Run tests with
ENV["CUDA_VISIBLE_DEVICES"] = "-1" - Check explicit imports: Run
quality_assurancetest
Key Conventions
- File names: snake_case
- Type names: PascalCase
- Function names: snake_case
- Kernel names: may be prefixed with underscore (e.g.,
_compute_tendency_kernel) - Extend functions via
Module.function_name(...), never viaimport
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.

