From 76253de03169c493d4237e7150f207b82df017d1 Mon Sep 17 00:00:00 2001 From: Waleed Latif Date: Mon, 26 May 2025 09:53:29 -0700 Subject: [PATCH] chore: update CONTRIBUTING.md --- .github/CONTRIBUTING.md | 6 ++++++ package.json | 3 ++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index d3c78b77f..3eb3e5cd6 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -411,6 +411,12 @@ In addition, you will need to update the registries: 7. **Test Your Tool:** Ensure that your tool functions correctly by making test requests and verifying the responses. +8. **Generate Documentation:** + Run the documentation generator to create docs for your new tool: + ```bash + ./scripts/generate-docs.sh + ``` + ### Naming Conventions Maintaining consistent naming across the codebase is critical for auto-generation of tools and documentation. Follow these naming guidelines: diff --git a/package.json b/package.json index 0a697720b..de944b306 100644 --- a/package.json +++ b/package.json @@ -45,6 +45,7 @@ "lint-staged": { "*.{js,jsx,ts,tsx,json,css,scss,md}": [ "biome check --files-ignore-unknown=true" - ] + ], + "!.github/*.md": [] } }