Branch: refs/heads/master Home: https://github.com/xwiki/xwiki-dev-llm Commit: 4d69736647089f3162e403cc9ece8c120ed5793a https://github.com/xwiki/xwiki-dev-llm/commit/4d69736647089f3162e403cc9ece8c... Author: Simon Urli <[email protected]> Date: 2026-09-15 (Tue, 15 Sep 2026) Changed paths: M xwiki/instructions/xwiki-org.md A xwiki/okf/conventions/velocity-code-style.md M xwiki/okf/index.md Log Message: ----------- [Misc] Record the Velocity code style conventions in the OKF * Add okf/conventions/velocity-code-style.md from dev.xwiki.org's Velocity Code Style page, which had no home in the OKF: code-style.md is Java and build level, and server-side-rendering.md only covers what space gobbling does to generated wiki syntax, not how to write the Velocity itself. * Lead with the rule that prompted this, since it is the one a reviewer catches: a call whose return value is not meant to be rendered goes through #set ($discard = $call), because a bare call leaks the value, or an empty line, into the output. * Record the trap behind the "space after a directive name" rule: several XWiki builtins that look like directives are macros and so take no space, #template('startpage.vm') among them. * Note where the page and code-comments.md differ on issue references in comments, so that following one of the two pages alone does not produce a comment the other rejects. Co-Authored-By: Claude Opus 5 (1M context) <[email protected]> Commit: 4def7aee7fd6fcecf0b0973e43e01202ad6e8839 https://github.com/xwiki/xwiki-dev-llm/commit/4def7aee7fd6fcecf0b0973e43e012... Author: Vincent Massol <[email protected]> Date: 2026-09-15 (Tue, 15 Sep 2026) Changed paths: M xwiki/okf/conventions/script-services.md M xwiki/okf/conventions/velocity-code-style.md M xwiki/okf/index.md Log Message: ----------- [Misc] Make the Velocity topic the single home of the Velocity conventions * Drop the comment rule about quoting an issue ID and title: it is not Velocity-specific and code-comments already rules on it — point there instead. * Turn the Related section into the index of the Velocity rules held by other topics, adding script-services and translations. * Name velocity-code-style from script-services, where $discard was used without being defined. Co-Authored-By: Claude Opus 5 (1M context) <[email protected]> Commit: 652f21dc19695873f9a20cc338c8345db2456912 https://github.com/xwiki/xwiki-dev-llm/commit/652f21dc19695873f9a20cc338c834... Author: Vincent Massol <[email protected]> Date: 2026-09-15 (Tue, 15 Sep 2026) Changed paths: M xwiki/instructions/xwiki-org.md M xwiki/okf/conventions/code-comments.md M xwiki/okf/conventions/velocity-code-style.md M xwiki/okf/index.md Log Message: ----------- [Misc] Hold the issue-reference comment rule in code-comments, for every language * code-comments is the generic home: it now says a comment must stand on its own once its links are dead, that referencing an issue is optional and allowed in addition to that reason, and that such a reference carries the issue ID and its title. * This replaces the previous blanket ban on issue references in code, in the topic and in the always-on mirror. * velocity-code-style just points at it, since the rule is not Velocity-specific even though the dev wiki currently states it on the Velocity page only. Co-Authored-By: Claude Opus 5 (1M context) <[email protected]> Commit: 111503058e22cc437d75201cb70c7975c007acfe https://github.com/xwiki/xwiki-dev-llm/commit/111503058e22cc437d75201cb70c79... Author: Vincent Massol <[email protected]> Date: 2026-09-15 (Tue, 15 Sep 2026) Changed paths: M xwiki/okf/conventions/code-comments.md Log Message: ----------- [Misc] Make the comment example carry its own explanation The example showed an issue ID and title standing in for the reason, which is exactly what the rule above forbids: a title states the symptom, not why the code does what it does. The comment now explains the problem on its own and the issue reference only adds detail. Co-Authored-By: Claude Opus 5 (1M context) <[email protected]> Commit: b152b8ee35d4c1437d27f8e010a02397e8b41dc9 https://github.com/xwiki/xwiki-dev-llm/commit/b152b8ee35d4c1437d27f8e010a023... Author: Vincent Massol <[email protected]> Date: 2026-09-15 (Tue, 15 Sep 2026) Changed paths: M xwiki/instructions/xwiki-org.md M xwiki/okf/conventions/code-comments.md M xwiki/okf/conventions/script-services.md A xwiki/okf/conventions/velocity-code-style.md M xwiki/okf/index.md Log Message: ----------- Merge pull request #137 from xwiki/velocity-code-style-okf [Misc] Record the Velocity code style conventions in the OKF Compare: https://github.com/xwiki/xwiki-dev-llm/compare/86bca75cf323...b152b8ee35d4 To unsubscribe from these emails, change your notification settings at https://github.com/xwiki/xwiki-dev-llm/settings/notifications