star-code-release

Consolidate research code and documentation into a public-ready repository format.

39|Updated Jul 15, 2026
One-click install
npx skills add https://github.com/wanghao9610/STAR --skill star-code-release
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: star-code-release
Source: https://github.com/wanghao9610/STAR/tree/main/.cursor/skills/star-code-release
Command: npx skills add https://github.com/wanghao9610/STAR --skill star-code-release

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve?

This Skill solves the challenge of preparing a research repository for open-source release by automating the consolidation of scattered code, polishing documentation, and ensuring the project is legible for external readers.

Core Features & Use Cases

  • Evidence-Based Consolidation: Automatically gathers code from scratch directories into the project codebase only if it is cited, executed, or reproduces results.
  • Automated README Compilation: Generates a professional README by mapping project artifacts, results, and methods into a structured, verified document.
  • Hygiene & Safety Sweep: Performs a blocking check for secrets, machine-local paths, and license conflicts before release.
  • Use Case: When a researcher wants to publish their AI project, this Skill ensures the repository is clean, the README is accurate, and no sensitive local environment data is accidentally exposed.

Quick Start

Run the star-code-release skill to perform a full release preparation pass including gathering, polishing, documentation, and hygiene checks.

Frequently Asked Questions about star-code-release

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I prepare a research code repository for open-source release?

To prepare a research repository for release, you consolidate scattered code, generate verified documentation, and run hygiene checks. This process validates file provenance against project plans and ensures the codebase is legible for external readers.

How does automated repository consolidation handle uncited research code?

Automated repository consolidation gathers code from scratch directories into the project codebase only if it is cited, executed, or reproduces results. This evidence-based approach validates file provenance against your project plans and results tables.

Can I automatically generate a README from my existing project artifacts and results?

Yes, you can automatically generate a professional README by mapping project artifacts, results, and methods into a structured, verified document. This compilation ensures your documentation accurately reflects the consolidated codebase.

What is the best way to detect sensitive credentials and local paths before publishing code?

The best way to detect sensitive credentials and local paths is to perform a blocking hygiene sweep before release. This safety check scans for secrets, machine-local paths, and license conflicts to prevent accidental environment data exposure.

Does release preparation check for license conflicts in consolidated research code?

Yes, release preparation performs a blocking hygiene sweep that detects and blocks license conflicts alongside sensitive credentials and local system paths. This ensures your consolidated research repository is public-ready and compliant.

When should I run a repository hygiene sweep during my research project release?

You should run a repository hygiene sweep as the final blocking check after consolidating code and generating documentation. This ensures no sensitive local environment data, secrets, or machine-local paths are included before public release.