Browse / Learning Documentation / Lifeguard Rule Generation

Lifeguard Rule Generation

Generates structured, project-specific rules in a `lifeguard.yaml` file to guide and standardize code reviews.

SkillLearning DocumentationTechnical WritingDocs StandardsProject Management

The source repository doesn't declare a license. Check its terms before reusing the code.

Key features

  • Organizes rules by placing general best practices before project-specific ones.
  • Analyzes codebases to identify project-specific conventions and anti-patterns.
  • Creates concise, single-purpose rules for clarity and focus.
  • Generates guidelines for bug prevention, code simplicity, and dependency management.
  • Structures rules with a consistent naming convention (e.g., LG-<keyword>-001).

Use cases

  • Onboarding new developers with a clear checklist for code quality and style.
  • Automating the documentation of a team's coding conventions and best practices.
  • Establishing a formal code review standard for a new or existing project.

FAQ

What are the key capabilities of this skill?

The skill analyzes code to identify project-specific conventions and anti-patterns, creates concise, single-purpose rules with a consistent naming convention, and generates guidelines for bug prevention, code simplicity, and dependency management.

When should I use this skill?

Use this skill when you want to establish or improve code quality standards for a project. It's ideal for onboarding new team members, ensuring consistency across a codebase, or codifying existing conventions.

What does the Lifeguard Rule Generation skill do?

This skill automatically analyzes your codebase to create a structured `lifeguard.yaml` file. This file contains project-specific rules and best practices to guide and standardize your team's code review process.

How does this skill improve my development workflow?

It automates the creation of code review guidelines, saving you time. By providing a clear, structured set of rules in a `lifeguard.yaml` file, it streamlines reviews, reduces ambiguity, and helps developers catch common issues early.