agents: refactor, include more guidelines#24111
Conversation
|
|
||
| 4. **Respect maintainers' time.** Search for existing issues and discussions before submitting. Ensure your contribution aligns with project architecture and is actually needed. | ||
| - Avoid emdash `—`, unicode arrow `→` or any unicode characters: `×`, `…` ; use ASCII equivalents instead: `-`, `->`, `x`, `...` | ||
| - Keep code comments concise; avoid redundant or excessive inline commentary |
There was a problem hiding this comment.
A typical bad behaviour is when adding a new model, where there is lots of copy-paste from existing model code, but interspersed with lots of useless comments about model specifics.
So, perhaps formulate something along the lines of not adding comments when templating from existing code.
There was a problem hiding this comment.
can you point to a PR that has such behavior (only give me the PR number is enough)
I think it's best to include them as examples
There was a problem hiding this comment.
22540 (self-closed for whatever reason, but a nice example)
There was a problem hiding this comment.
added some more examples via a4713ca , PTAL
There was a problem hiding this comment.
Great, the excessive inline commentary should hopefully address the rest without need of examples.
* origin/master: (57 commits) server : disable on-device spec checkpoints (ggml-org#24108) arg: fix double mtp downloads (ggml-org#24128) webui: [a11y] fix keyboard navigation issues in chat interface and sidebar (ggml-org#23132) Move duplicated imatrix code into single common imatrix-loader.cpp (ggml-org#22445) ui: Fixed packages (ggml-org#24119) ui: added single line reasoning preview (ggml-org#23601) return filter to save memory (ggml-org#24125) convert: Fix Gemma 4 Unified conversion (ggml-org#24118) ggml: vectorize ggml_vec_dot_q4_1_q8_1 with WASM SIMD128 (ggml-org#22209) server: avoid unnecessary checkpoint restore when new tokens are present (ggml-org#24110) agents: refactor, include more guidelines (ggml-org#24111) webui: fix tool selector toggle/counter, key tools by stable identity (ggml-org#24065) build : use umbrella Headers directory for XCFramework module map (ggml-org#23974) server : add header to tools/server/server-http.h (ggml-org#24089) cmake: skip cvector-generator and export-lora when CPU backend is disabled (ggml-org#24053) fix(mtmd): handle Gemma 4 audio projector embedding size (ggml-org#24091) readme : add status badges (ggml-org#24104) tests : refactor test-save-load-state to accept token input (ggml-org#24073) metal : reduce rset heartbeat from 500ms -> 5ms (ggml-org#24074) ggml-webgpu: FlashAttention refactor + standardize quantization support (ggml-org#23834) ...
Overview
refactor
AGENTS.mdto clarify about project's code standard (e.g. no excessive comments, no unicode, etc)cc @ggml-org/maintainers for review & discussion
Requirements