open sourcing

Productivity Community

Skill notes

When to Use

Making a private repository public Auditing an existing public repository for release quality ("make it official") Choosing a license for a project Setting up packaging, versioning, or release automation ahead of a public

When NOT to Use

Routine development on an already-released project (no release event) Auditing third-party code for vulnerabilities (use a security-review skill) Publishing a package from a repository that will stay private — only the release-management steps apply; skip the rest

Step 1: Detect the organization profile

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

Step 2: Audit for secrets — before anything else

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.

Step 3: Run the readiness check

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

Fluxly profile Runtime and permissions are inferred by Fluxly static checks, not author declarations or runtime test results.
Domain
Productivity
Author-declared agents
No explicit declaration found; this is not inferred or tested compatibility
Static check
88 / 100 · heuristic scan, not runtime safety proof
Runtime evidence
Not run; no isolated runtime test evidence is currently recorded
Author / version / license
@trailofbits · no license declared
Token usage
Lean
Setup complexity
Plug-and-play
External API key
Not required
Operating systems
Unspecified (assume cross-platform)
Runtime requirements
Python
Detected file/system behavior
  • Read-only
  • Write / modify
Network behavior
Local-only
Install commands
None (reference only)

Heads up: Tool permissions are not declared; actual access depends on the runtime.

01
Step 1: Detect the organization profile

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

02
Step 2: Audit for secrets — before anything else

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.

03
Step 3: Run the readiness check

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

04
Step 4: Documentation

The README is the project's front door. Confirm it explains: What the project is and what problem it solves (first paragraph) How to install it — package manager, container image, or build from source; a fresh-clone build must work using only what is in the repository How to use it — at least one concrete, copy-pasteable example

05
Step 5: Licensing

No license means not open source, regardless of visibility. Read references/licensing.md for selection criteria and mechanics. The short version: Apply the organization's policy if one was detected in Step 1. Otherwise: Apache 2.0 as the permissive default, AGPLv3 when private

06
Step 6: Tests and CI

Confirm the test suite exists and passes; a public repository with a failing default branch signals abandonment. Ensure CI runs the tests on every PR, across the supported language-version and platform matrix. Enforce formatting and linting in CI (per-language tooling in the

07
Step 7: Repository settings

Branch protection on the default branch: no force pushes, PRs required. Prefer rulesets for new repositories; classic branch protection remains supported. Merge protection: required status checks so PRs cannot merge with failing tests.

08
Step 8: Releases and versioning

Tag every release `vX.Y.Z`, following semver; use `-rc.N` / `-pre.N` suffixes for release candidates and prereleases. Make releases CI-driven: pushing a tag (or publishing a GitHub Release) triggers build, packaging, and upload with no manual steps. A release should be `git tag vX.Y.Z && git push origin vX.Y.Z`.

09
Step 9: Language-specific practices

Identify the project's languages from its marker files and read the matching reference for packaging, publishing, and quality tooling: Marker file · Reference `pyproject.toml`, `setup.py` · references/python.md — defers to the modern-python skill for tooling `CMakeLists.txt`, `Makefile` (C/C++) · references/c-cpp.md

Discussion

Powered by GitHub Discussions. Sign in with GitHub to comment, react, or subscribe.