All skills
asyrafhussin avatar

/project-docs

@6cadc91

Project documentation lifecycle for PHP/Laravel and Node/TypeScript/React projects — bootstrapping essential docs, naming and folder conventions, freshness, and cleanup of AI-generated junk and stale files. Use when starting a new project, setting up docs/ structure, auditing markdown files, cleaning up the docs folder, or deciding which docs to keep, archive, or delete. Triggers on "set up docs", "audit docs", "clean up markdown", "what docs does this project need", "organize docs folder", "find stale docs".

Use this Skill: https://skilld.dev/gh/asyrafhussin/agent-skills/project-docs

This session only. Nothing lands on disk.

rulesessential-license.md

≈877 tokens on demand. Your agent reads this file only when SKILL.md points to it.

LICENSE — Required Legal Clarity

Impact: CRITICAL (Without a license, code is technically un-reusable; many companies' legal review blocks adoption outright)

A repository without a LICENSE file means all rights reserved by default in most jurisdictions — nobody can legally use, copy, or modify the code, even if it's public. Every serious open-source project has one, and most companies' legal teams reject internal adoption of unlicensed dependencies.

Required

LICENSE                       # at repo root, no extension by convention

Contents: the full text of the license you've chosen. For MIT, that's the standard ~20-line text with <year> and <copyright holder> filled in.

Choosing a license

Use choosealicense.com — it asks 2–3 questions and recommends one. Common picks:

License When Notes
MIT Permissive; you want maximum adoption Short, well-known, allows commercial use
Apache-2.0 Permissive + explicit patent grant Slightly longer; common for company-backed OSS
AGPL-3.0 Copyleft + network-use clause SaaS deployments must share modifications
BSL / Elastic 2.0 Source-available, time-delayed open "Open-ish" — verify it suits your goal
Proprietary Closed-source Add LICENSE saying "All rights reserved" + contact for commercial terms

For internal-only repos, still include a LICENSE file stating the company holds copyright and the code is for internal use only. This removes ambiguity for departing employees and contractors.

Incorrect

❌ No LICENSE file at all
.
├── README.md
├── CHANGELOG.md
└── src/...
❌ Wrong placement / naming
.
├── docs/license.txt          (should be at root, named LICENSE)
└── LICENSE.MD                (works but unconventional case)
❌ "MIT" mentioned only in README, no file
README:
> ## License
> MIT

(GitHub will not detect this as MIT licensed; license badges and tooling will fail.)

Correct

✅ LICENSE at root
.
├── LICENSE                   ← the full license text
├── README.md
└── src/...

README links to it:

## License

[MIT](LICENSE)

License consistency in package manifests

Keep the manifest field in sync with the LICENSE file:

// package.json
{
  "license": "MIT"
}
// composer.json
{
  "license": "MIT"
}

Mismatch (LICENSE says MIT, package.json says Apache-2.0) trips up npm audit, license-scanning tools, and human reviewers.

Detection

test -f LICENSE -o -f LICENSE.md -o -f LICENSE.txt || echo "MISSING LICENSE"

# Compare LICENSE to package.json (rough sanity check)
LICENSE_NAME=$(grep -oE '(MIT|Apache|BSD|GPL|ISC|MPL)' LICENSE | head -1)
PKG_LICENSE=$(node -e "console.log(require('./package.json').license)" 2>/dev/null)
echo "LICENSE file: $LICENSE_NAME, package.json: $PKG_LICENSE"

Reference: Choose a License · GitHub — Licensing a repository · SPDX license list

Source: SKILL.md on GitHub

No alerts16d3 checks · Risk SAFE
  • Gen Agent Trust Hub16d

    The skill is a comprehensive documentation lifecycle management tool for PHP/Laravel and Node.js projects. It provides a set of 25 rules for organizing, naming, and maintaining project documentation. The analysis found no security issues; the skill utilizes standard auditing practices and suggests well-known industry tools for documentation linting and quality assurance.

  • Socket16d

    No alerts

  • Snyk16d

    Risk: LOW · No issues

Signed by skilld at 6cadc91. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub last month.

Steadyupdated 5 months ago
metadata
{
  "author": "agent-skills",
  "version": "1.0.0"
}

README badge

README badge for asyrafhussin/agent-skills/project-docs