rsyslog_commit

Validate commit messages and code style for the rsyslog project.

2.3k|728|Updated Jun 3, 2013
One-click install
npx skills add https://github.com/rsyslog/rsyslog --skill rsyslog-commit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rsyslog_commit
Source: https://github.com/rsyslog/rsyslog/tree/main/.agent/skills/rsyslog_commit
Command: npx skills add https://github.com/rsyslog/rsyslog --skill rsyslog-commit

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires devtools, and includes scripts (resource) components.

What problem does it solve?

This Skill ensures that all commits to the rsyslog project adhere to strict commit message and branching policies, improving code quality and maintainability.

Core Features & Use Cases

  • Commit Message Formatting: Standardizes commit messages with a structured format.
  • Code Style Enforcement: Enforces code style compliance before commits.
  • Pre-commit Checklist: Provides a comprehensive checklist for developers.
  • Use Case: Before submitting a pull request, developers can use this Skill to validate their commit messages and code style, ensuring adherence to project standards.

Quick Start

Run the rsyslog_commit skill to validate your commit message and code style before pushing to the main branch.

Frequently Asked Questions about rsyslog_commit

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I validate rsyslog commit messages before submitting a pull request?

You validate rsyslog commit messages by running this Skill, which checks your messages against structured formatting standards to ensure compliance before you submit a pull request.

What is the structured commit message format required for the rsyslog project?

The rsyslog project enforces a structured commit message format to maintain strict branching policies, improving code quality and maintainability across the development workflow.

Do I need local build and test environments to enforce rsyslog code style?

Yes, enforcing rsyslog code style requires local formatting tools and a local build environment to properly validate code formatting guidelines and run tests before commits.

Can I use devtools to run a pre-commit checklist for rsyslog code quality?

Yes, this Skill leverages the devtools dependency to provide a comprehensive pre-commit checklist that validates code quality and formatting guidelines for the rsyslog project.

Why does my rsyslog commit fail validation checks?

Your rsyslog commit fails validation if the commit message lacks the structured format or the code violates project style guidelines, which this Skill identifies before you push to the main branch.