From 249704cfca3794b4e1ac9cca06b6d36bbc31e414 Mon Sep 17 00:00:00 2001 From: Netzenbot Date: Fri, 20 Mar 2026 11:23:36 -0400 Subject: [PATCH] Rename BEST-PRACTICES.md to best_practices.md (#34861) Update all internal references in skill docs. --- .claude/skills/add-best-practice/SKILL.md | 8 ++++---- .claude/skills/fix-bp-docs/SKILL.md | 6 +++--- docs/{BEST-PRACTICES.md => best_practices.md} | 0 3 files changed, 7 insertions(+), 7 deletions(-) rename docs/{BEST-PRACTICES.md => best_practices.md} (100%) diff --git a/.claude/skills/add-best-practice/SKILL.md b/.claude/skills/add-best-practice/SKILL.md index 6c08b208de0..1e530a5c9d4 100644 --- a/.claude/skills/add-best-practice/SKILL.md +++ b/.claude/skills/add-best-practice/SKILL.md @@ -21,7 +21,7 @@ entries. ## Step 1: Verify Working Directory This skill runs from the brave-core (`src/brave`) directory. Best practices docs -are at `./docs/best-practices/` and the index is at `./docs/BEST-PRACTICES.md`. +are at `./docs/best-practices/` and the index is at `./docs/best_practices.md`. Set `DOCS_DIR="./docs/best-practices"`. @@ -45,7 +45,7 @@ If the description is vague, ask the user to clarify before proceeding. Search ALL existing best-practice documents for rules that already cover this topic: -1. Read the index file `docs/BEST-PRACTICES.md` to understand document +1. Read the index file `docs/best_practices.md` to understand document categories 2. Use Grep to search across all docs in `$DOCS_DIR/*.md` for keywords related to the new practice @@ -81,7 +81,7 @@ attract multiple related practices**, create a new category document: 1. Choose a descriptive filename (e.g., `performance.md`, `security-practices.md`) 2. Add a prefix mapping to `script/manage-bp-ids.py` in the `DOC_PREFIXES` dict -3. Add an entry in `docs/BEST-PRACTICES.md` index under the appropriate section +3. Add an entry in `docs/best_practices.md` index under the appropriate section 4. Create the new doc with a `# Title` header and cross-reference comment **If it doesn't fit but is a one-off**, find the closest existing document and @@ -170,7 +170,7 @@ and the ID assignment — they are one logical unit). ```bash git add $DOCS_DIR/.md -# Also add manage-bp-ids.py and docs/BEST-PRACTICES.md if they were modified +# Also add manage-bp-ids.py and docs/best_practices.md if they were modified git commit -m "Add best practice: " ``` diff --git a/.claude/skills/fix-bp-docs/SKILL.md b/.claude/skills/fix-bp-docs/SKILL.md index 41be5d8fa48..8be7152031f 100644 --- a/.claude/skills/fix-bp-docs/SKILL.md +++ b/.claude/skills/fix-bp-docs/SKILL.md @@ -19,7 +19,7 @@ must be run from the `brave-core` directory. ## Step 1: Paths This skill runs from the brave-core (`src/brave`) directory. Best practices docs -are at `./docs/best-practices/` and the index is at `./docs/BEST-PRACTICES.md`. +are at `./docs/best-practices/` and the index is at `./docs/best_practices.md`. Set `DOCS_DIR="./docs/best-practices"`. @@ -27,7 +27,7 @@ Set `DOCS_DIR="./docs/best-practices"`. ## Step 2: Read All Best Practice Files -Read `docs/BEST-PRACTICES.md` and every file in `$DOCS_DIR/*.md` to understand +Read `docs/best_practices.md` and every file in `$DOCS_DIR/*.md` to understand the full set of docs. --- @@ -118,7 +118,7 @@ Look for: ## Step 10: Check the Index -Verify `docs/BEST-PRACTICES.md`: +Verify `docs/best_practices.md`: - All listed docs exist - No doc is listed twice diff --git a/docs/BEST-PRACTICES.md b/docs/best_practices.md similarity index 100% rename from docs/BEST-PRACTICES.md rename to docs/best_practices.md