Skip to content

Prepare skills for coming code changes - #736

Merged
AltraMayor merged 2 commits into
masterfrom
agent-skill
Sep 18, 2026
Merged

AltraMayor merged 2 commits into
masterfrom
agent-skill

Conversation

@AltraMayor

Copy link
Copy Markdown
Owner

Enhance commit-message guidelines and add coding-style documentation.

Michel Machado added 2 commits September 18, 2026 14:47
The commit-message skill lacked rules for referencing functions and
manual section numbers, which are consistently used across Gatekeeper's
git history.

Update the guidelines in .agents/skills/commit-message/SKILL.md to:
1. Require empty parentheses () after internal and project function
   names as well as function-like macros.
2. Require manual section numbers in parentheses after standard library
   functions (e.g. free(3), perror(3)), system calls
   (e.g. getrandom(2)), commands (e.g. ls(1)), and overview pages
   (e.g. capabilities(7)).
3. Clarify plain text conventions without Markdown backticks.
4. Detail subsystem prefix categories, subject casing exceptions, and
   issue reference formulas with real-world examples from the git log.
Gatekeeper follows DPDK's coding style guidelines, which are based on
the Linux Kernel coding guidelines and FreeBSD kernel developer's manual
style(9). However, agents assisting in the repository lacked explicit
instructions and reference documentation on these conventions.

Add an agent skill under .agents/skills/coding-style/ that documents the
coding style requirements, referencing the official DPDK documentation
at https://doc.dpdk.org/guides/contributing/coding_style.html.

This skill provides:
1. An agent verification checklist covering indentation (hard tabs),
   line length limits, comment syntax, include order, and pointer/NULL
   conventions.
2. Comprehensive rules for C preprocessor directives, variable and
   structure declarations, function definitions and prototypes, control
   statements, operators, and casts.
3. Gatekeeper-specific idioms, including G_LOG() logging macros,
   RTE_BUILD_BUG_ON(), and RTE_VERIFY().
4. Guidelines for Python (PEP 8) and Meson build files.
@AltraMayor AltraMayor added this to the Version 1.3 milestone Sep 18, 2026
@AltraMayor
AltraMayor merged commit 3f3e4b9 into master Sep 18, 2026
1 check passed
@AltraMayor
AltraMayor deleted the agent-skill branch September 18, 2026 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant