skills.rest
baan-press
baan-pressOFFICIAL
Explore all skills by this author →
GitHub

release-docs-check

Verify README, package.json, .env.example, .gitignore, and LICENSE for release compliance.

Updated Jun 14, 2026
Search Tags:#code audit#metadata validation#release verification#pre-release check#document consistency
One-click install
npx skills add https://github.com/baan-press/baan --skill release-docs-check
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: release-docs-check
Source: https://github.com/baan-press/baan/tree/main/.claude/skills/release-docs-check
Command: npx skills add https://github.com/baan-press/baan --skill release-docs-check

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill addresses the need for thorough documentation and metadata validation before releasing software, ensuring consistency across crucial files and data.

Core Features & Use Cases

  • Documentation Consistency: Checks README, package.json, .env.example, .gitignore, and LICENSE for correct formatting and consistency.
  • Error Reporting: Identifies issues like incorrect field values, placeholders, or outdated references with specific file and line numbers.
  • Quick Audit: Useful for auditors or developers looking to ensure all release prerequisites are met.

Quick Start

Run the release-docs-check skill to validate your project's documentation and metadata readiness.

Frequently Asked Questions about release-docs-check

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

FAQPage Schema
How do I verify documentation consistency before a software release?▼

Pre-release documentation verification checks README, package.json, .env.example, .gitignore, and LICENSE files for correct formatting and consistency with project standards to ensure release files are error-free.

What is pre-release metadata validation for software projects?▼

Pre-release metadata validation is the process of auditing crucial files like package.json and LICENSE to confirm compliance with project requirements and identify outdated references before publishing.

How do I check package.json and README files for release readiness?▼

Checking package.json and README for release readiness involves running an audit to identify incorrect field values, placeholders, or outdated references with specific file and line numbers for quick resolution.

Can I identify incorrect field values and placeholders in my project files?▼

Yes, you can identify incorrect field values and placeholders in project files by running an error reporting audit that locates issues with specific file and line numbers to ensure all release prerequisites are met.

Does pre-release check support .env.example and .gitignore compliance?▼

Pre-release check supports .env.example and .gitignore compliance by verifying these files against project standards, ensuring documentation and metadata consistency across all crucial release files.

Related Skills

Explore More Software Engineering Skills→
DaleSeoDaleSeo
4

bun-init

Initialize Bun projects with TypeScript and standard configuration files.

Community
Advanced
hiddink-aihiddink-ai
1

hiddink-harness:npm-publish

Automate npm package publication with pre-publish validation and registry deployment.

Official
Intermediate
R2W1csR2W1cs
1

lint-and-validate

Lint and validate JavaScript and Python code for syntax and style issues.

Community
Intermediate
sinositatosinositato

prd-validate

Lints PRD files for missing sections, metadata, placeholders, formatting, and table integrity.

Community
Basic