- name
SKILL.md
技能檔案保留在發布者的儲存庫中。
在終端機中貼上複製的指令。它會將這個 SKILL.md 安裝到對應的代理中。
npx skills add trailofbits/skills --skill open-sourcing -a cursor -y在終端機中貼上複製的指令。它會將這個 SKILL.md 安裝到對應的代理中。
npx skills add trailofbits/skills --skill open-sourcing -a claude-code -y在終端機中貼上複製的指令。它會將這個 SKILL.md 安裝到對應的代理中。
npx skills add trailofbits/skills --skill open-sourcing -a codex -y在終端機中貼上複製的指令。它會將這個 SKILL.md 安裝到對應的代理中。
npx skills add trailofbits/skills --skill open-sourcing -a grok -y在 Grok Bot 聊天中傳送複製的訊息。Bot 會從 GitHub 取得這個 SKILL.md,並加入你所有 Bot 共用的技能中。
Install this skill: https://github.com/trailofbits/skills/tree/HEAD/plugins/open-sourcing/skills/open-sourcing來自發布者
Prepare a repository for public release so that an outsider with no prior context can build, use, and contribute to it — and so that nothing sensitive ships with it. Work through the steps in order; the secrets audit comes first because its outcome (keeping vs. recreating the repository) affects everything after it.
bash {baseDir}/scripts/detect_org.sh
The script inspects git remotes and recent committer emails, and prints a
profile name. If it prints trailofbits, read
references/trailofbits.md now and apply its
license policy, publishing accounts, and process notes throughout the
remaining steps. If it prints generic, proceed with the generic guidance
alone. If the user says the detection is wrong, trust the user.
A repository that has ever contained secrets (API keys, credentials, client data) should not be flipped public. History rewriting is error-prone and does not reach forks, caches, or CI artifacts. The reliable fix is a fresh repository: copy the current tree over, commit, and archive the old repository privately.
gitleaks git . or trufflehog git file://. — rather than eyeballing.Reject these rationalizations — this is the one step that cannot be fixed after publication:
bash {baseDir}/scripts/check_readiness.sh
The script prints a checklist of presence indicators (README, LICENSE, CONTRIBUTING, SECURITY.md, CI, tests, semver tags, ...) and warns about tracked files that commonly contain secrets. Treat unchecked items as discussion prompts, not hard failures — a research prototype does not need everything a flagship library needs. Walk through the gaps with the user and fix the ones that matter for this project.
The README is the project's front door. Confirm it explains:
CONTRIBUTING.mdAlso add:
SECURITY.md with vulnerability-reporting instructions (a contact
address or GitHub private vulnerability reporting). For security tooling
this is table stakes.No license means not open source, regardless of visibility. Read references/licensing.md for selection criteria and mechanics. The short version:
LICENSE file, set SPDX identifiers in package metadata, state
the license in the README, and verify all three agree.github-actions so pins stay current.permissions: blocks (start from permissions: {}).zizmor .github/workflows/ and lint with actionlint..editorconfig so contributors' editors agree on whitespace basics.C: component, P: platform). See
blight's labels for a
worked example.vX.Y.Z, following semver; use
-rc.N / -pre.N suffixes for release candidates and prereleases.git tag vX.Y.Z && git push origin vX.Y.Z.Identify the project's languages from its marker files and read the matching reference for packaging, publishing, and quality tooling:
For other ecosystems, apply the cross-cutting principles: reproducible builds from a fresh clone, CI-driven releases, trusted publishing or organization-owned accounts, and license metadata in the package manifest.
Before the visibility switch is flipped, verify from an outsider's perspective:
{baseDir}/scripts/check_readiness.sh and confirm the remaining
gaps are deliberate choices, stated to the user.Making the repository public is then a repository-settings change. Pair the release with an announcement where the organization has a process for one.
scripts/detect_org.sh — prints the organization profile
(trailofbits or generic) from git remotes and committer emailsscripts/check_readiness.sh — prints presence indicators for
release-readiness files and flags tracked files that commonly hold secretsThis 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
---name: open-sourcingdescription: This skill should be used when the user asks to "open source this project", "prepare this repository for…---# plugins/open-sourcing/skills/open-sourcing/SKILL.md總覽
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.
常見問題
從發布者下載 plugins/open-sourcing/skills/open-sourcing/SKILL.md,或複製路徑後開啟儲存庫。PlugMCP 只收錄這項技能,不代管檔案。
發布者將它存放在 https://github.com/trailofbits/skills。
Claude、Cursor、Codex 和 Grok Build 可以讀取你從發布者儲存庫加入的 SKILL.md。在聊天中傳送技能的 GitHub 資料夾連結,Grok Bot 就會安裝它。