Skip to content
SkillModel-led2,284 tokens in use

open-sourcing

A step-by-step workflow for making a repository public: secrets audit first, then readiness checks, docs, licensing, CI, settings and releases.

8,319 stars on the repository CC-BY-SA-4.0trailofbits/skills · plugins/open-sourcing/skills/open-sourcing
/plugin marketplace add trailofbits/skills
View source

Install command as written in the repository's README

Skill label

measured from its files

What installing open-sourcing costs

82tokens idle
2,284tokens in use
8,008tokens, up to

Idle is what sits in context while the skill is installed. In use is its instructions, loaded when it runs. Up to adds the files its instructions link. Counts are approximate, made offline with cl100k_base.

Model dependence Model-led

Script-ledMixedModel-led

Mostly instructions, so how well it works depends on the model that follows them.

This describes the skill's structure, how much of it is scripts. It does not say how well it works. Scripts: scripts/check_readiness.sh, scripts/detect_org.sh.

Touches

shelldetectedgitdetected

Declared tags come from the skill's frontmatter; detected ones from its scripts, its code blocks and the commands it names in inline code. This is detected, not audited.

How it scores

Quality

How well the skill is written, counted from its own files: its frontmatter, its steps, examples, stated output and constraints, its size and whether every file it ships is one it names.How we score it →
Excellent
  • Frontmatter12/15
  • Structure25/25
  • Examples12/15
  • Output10/15
  • Size15/15
  • Resources15/15

Security

Starts at 100 and loses points for each thing in the skill's files that a reader should look at first.How we score it →
Excellent
  • Runs shell commands−5

    does this on the machine, and the frontmatter does not say so

    SKILL.md, line 35
  • Runs git commands−5

    does this on the machine, and the frontmatter does not say so

    scripts/check_readiness.sh, line 41

Repository health

Pre-computed score based on development activity, maintenance, community, maturity, and trend momentum.How we score it →
Good
  • Development activity100
  • Maintenance52
  • Community64
  • Maturity32
  • Momentum40

Open-sourcing guides an agent through preparing a repository for public release so that an outsider can build, use and contribute to it, and nothing sensitive ships with it. The steps run in a fixed order, starting with a secrets audit because its outcome decides whether the repository can be published or must be recreated.

It then covers documentation, license selection, tests and CI hardening, repository settings, release tagging and per-language packaging. A Trail of Bits profile is loaded automatically when the repository belongs to that organization.

What You Get

  • A secrets audit step that tells you when a fresh repository is the safer route than rewriting history
  • A printed readiness checklist covering README, LICENSE, CONTRIBUTING, SECURITY policy, CI, tests and semver tags
  • License guidance with SPDX metadata rules and a consistency check between LICENSE, package metadata and README
  • Per-language reference notes for Python, C/C++, Rust, Go, JavaScript and Ruby
  • A final review from an outsider’s point of view: clean clone, build from the README, re-run the checklist

Common Use Cases

  • Making a private repository public
  • Auditing an existing public repository for release quality
  • Choosing a license for a new project
  • Setting up CI-driven releases and trusted publishing before a launch

What Makes It Unique

The skill puts the secrets audit before everything else and lists the excuses to reject, such as a revoked key or a history rewrite. It treats the readiness checklist as discussion prompts for the maintainer, and it tells the agent to keep working formatters and linters in place. An organization overlay for license policy and publishing accounts is applied when detected.

Under The Hood

The agent reads SKILL.md and loads reference files for licensing, the organization profile and the detected language only when needed. It runs two bundled shell scripts. One inspects git remotes and recent committer emails to pick a profile. The other checks for common files and lists tracked files that often hold secrets. It also suggests running secret scanners, a workflow audit tool and a workflow linter on the repository, and it may edit repository files such as LICENSE, README, SECURITY.md and workflow files. No network calls are made by the bundled scripts.

Join founders building with open source

Opinionated takes, migration guides, cost-saving tips, and insights from the open source ecosystem.

Subscribe on SubstackJoin 750+ subscribers