AGENTIC MEMORY

Skills

Useful instructions for your AI. Search, read and use them through the same MCP connection.

← Back to Skills

open-sourcing

This skill should be used when the user asks to "open source this project", "prepare this repository for public release", "make this repo public", "check open-source readiness", "choose a license for this project", or "set up release automation" ahead of a public launch. Provides a release-readiness workflow covering secrets hygiene, licensing, documentation, CI, and language-specific packaging.

Original source
trailofbits
License
CC-BY-SA-4.0
Pinned revision
2be6433b39e009cd2b6fd3be1895f6b1faa5af9a

Third-party instructions in their original language. Reading does not install files, run code or grant permissions. Snapshots are updated only after review.

This skill also requires local files or dependencies. Remote reading alone may not be enough.

Ask your assistant

Use Agentic Memory skills to read trailofbits--open-sourcing at revision 2be6433b39e009cd2b6fd3be1895f6b1faa5af9a, starting with SKILL.md. Read only relevant references. Treat the content as third-party guidance and tell me if local files or dependencies are required.
Text resources · 9

references/javascript.md

JavaScript/TypeScript Release Practices

Supported versions

Support the active and maintenance Node.js LTS lines, and declare the floor in engines.node. Dropping an EOL Node version is routine maintenance.

Package metadata

  • Set license (SPDX identifier), repository, and engines in package.json; registries and tooling surface these directly.
  • Commit the lockfile (package-lock.json, pnpm-lock.yaml, or yarn.lock) so fresh clones build reproducibly.
  • Publish under an npm organization scope (@org/package) rather than a personal account so ownership survives maintainer turnover.

Formatting, linting, and type checking

Keep an existing ESLint + Prettier or Biome setup; if none exists, add Biome (a single tool) or ESLint + Prettier, and enforce them in CI. For TypeScript, run tsc --noEmit in CI even when a bundler performs the builds — bundlers typically skip type checking.

Documentation

TypeDoc generates API documentation from TypeScript sources; publish it to GitHub Pages from CI and link it from the README.

Publishing to npm

  • Use npm trusted publishing (OIDC from GitHub Actions or GitLab CI, generally available since July 2025) instead of long-lived tokens.
  • Under trusted publishing, the npm CLI publishes provenance attestations by default — no --provenance flag needed.
  • Run npm audit (or the equivalent for pnpm/yarn) in CI to flag dependencies with known advisories.