Enhance README - #734
Merged
Merged
Enhance README#734
Conversation
added 5 commits
September 17, 2026 14:42
Add an agent skill under .agents/skills/commit-message/ that documents Gatekeeper commit message conventions. This skill provides on-demand instructions for AI agents when writing, formatting, or reviewing Git commit messages, ensuring consistent subsystem prefixes, imperative phrasing, and body formatting without incurring prompt overhead in unrelated tasks.
Remove shell prompts ('$' and '#') from code blocks in README.md so
commands can be directly copied and pasted.
Additionally, switch the code block language tags from 'console' to 'sh'
for shell syntax highlighting, and separate the 'lshw' command into its
own block with explicit 'sudo' followed by a dedicated sample output
block.
Update all HTTP URLs in README.md to use HTTPS, as all endpoints now support secure connections.
Update the hugepages setup example in README.md from 256 2MB pages to 2 1GB pages (2GB total). 1GB hugepages have become the typical and standard page size on modern systems running DPDK workloads, offering better TLB performance and lower overhead compared to 2MB pages.
Replace the 'dmesg | grep' command with 'ls /sys/class/iommu' in the IOMMU verification steps of README.md. The dmesg pattern was brittle across newer Linux kernels, unprivileged environments where dmesg_restrict is enabled, and non-Intel platforms. Inspecting /sys/class/iommu directly provides a reliable check across both Intel and AMD systems regardless of dmesg buffer state.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Enhance README and add commit-message skill for agents.