add-best-practice

Add best practice rules to documentation with stable IDs and duplicate checks.

3.5k|1.4k|Updated Nov 10, 2017
One-click install
npx skills add https://github.com/brave/brave-core --skill add-best-practice
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: add-best-practice
Source: https://github.com/brave/brave-core/tree/main/.claude/skills/add-best-practice
Command: npx skills add https://github.com/brave/brave-core --skill add-best-practice

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill streamlines the process of adding new best practices to the project's documentation, ensuring consistency, preventing duplicates, and maintaining a high standard of code quality.

Core Features & Use Cases

  • Best Practice Addition: Adds new rules to the appropriate documentation files.
  • Duplicate Checking: Prevents the addition of redundant or overlapping best practices.
  • ID Assignment: Automatically assigns stable, sequential IDs to new best practices.
  • Category Management: Creates new documentation categories if necessary.
  • Use Case: A developer identifies a new common pitfall in C++ code and wants to document it as a best practice to prevent future occurrences. This Skill helps them add it formally to the codebase's guidelines.

Quick Start

Use the add-best-practice skill to add a new rule about using std::move for rvalue references to the C++ coding guidelines.

Frequently Asked Questions about add-best-practice

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

FAQPage Schema
How do I add new coding guidelines to project documentation without creating duplicates?

To add new coding guidelines without duplicates, the Skill checks existing documentation, prevents redundant rules, assigns stable sequential IDs, and integrates the new entries using strict formatting.

What is the best way to manage documentation categories for developer tools?

Managing documentation categories is handled by creating new categories dynamically when necessary, ensuring new best practices are added to the appropriate files while maintaining strict formatting guidelines.

Do I need Python and Git to automate best practice ID assignment?

Yes, you need Python and Git to automate best practice ID assignment. Python scripts manage ID validation and sequencing, while Git handles version control operations for the updated documentation.

How does strict formatting validation work for code quality documentation?

Strict formatting validation for code quality documentation works by enforcing consistent structure across guideline files. It uses Python scripts to validate ID sequences and rule formats before committing changes via Git.

Can I use this approach to document C++ common pitfalls as formal rules?

Yes, you can document C++ common pitfalls as formal rules. The Skill allows developers to identify specific coding issues and formally add them to the codebase's guidelines to prevent future occurrences.