scrub-experiment-issue-tldrs

Update TL;DR summaries and links on experiment GitHub issues.

1.2k|146|Updated Mar 22, 2024
One-click install
npx skills add https://github.com/marin-community/marin --skill scrub-experiment-issue-tldrs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: scrub-experiment-issue-tldrs
Source: https://github.com/marin-community/marin/tree/main/.agents/skills/scrub-experiment-issue-tldrs
Command: npx skills add https://github.com/marin-community/marin --skill scrub-experiment-issue-tldrs

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill automates the process of keeping experiment issue summaries in the marin-community/marin repository up-to-date and easily understandable for newcomers.

Core Features & Use Cases

  • Automated Issue Summarization: Identifies and updates or adds TL;DR blocks to GitHub issues related to experiments.
  • Newcomer Friendliness: Ensures that experiment issues are accessible to users unfamiliar with the project's history.
  • Use Case: Regularly reviews closed and open experiment issues, adding concise summaries and relevant links to make past research efforts discoverable and understandable.

Quick Start

Run the scrub-experiment-issue-tldrs skill to update experiment issue summaries.

Frequently Asked Questions about scrub-experiment-issue-tldrs

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

FAQPage Schema
How do I automate GitHub issue summarization for experiment tracking?

Automate GitHub issue summarization by running a script that identifies experiment issues with weak or missing TL;DR blocks and updates them with concise summaries and helpful links. This ensures experiment tracking issues remain accessible to newcomers.

What's the best way to maintain newcomer-friendly documentation on experiment issues?

Maintain newcomer-friendly documentation by scanning open and closed experiment issues to add or update TL;DR blocks. This clarifies setup, investigation, and conclusions, making past research efforts discoverable for technically strong newcomers.

How does TL;DR block automation work for code maintenance on GitHub?

TL;DR block automation works by reviewing GitHub issues, identifying those with stale or missing summaries, and adding concise documentation with relevant links. This keeps experiment issues understandable without requiring manual editing of every issue.

Does this experiment issue summarization tool work with the marin-community repository?

Yes, this tool specifically targets the marin-community/marin repository. It reviews experiment issues within that repository, prioritizing those with weak, stale, or missing summaries to update them with concise TL;DR blocks and helpful links.

Can I update stale experiment tracking summaries on closed GitHub issues?

Yes, the tool regularly reviews both closed and open experiment issues to add or update TL;DR blocks. This makes historical research efforts and conclusions understandable to users unfamiliar with the project's past experiments.

Why do experiment issues need TL;DR blocks for newcomers?

Experiment issues need TL;DR blocks because past research efforts often lack clear summaries, making them inaccessible to newcomers. Adding concise summaries and links clarifies setup and conclusions, ensuring technically strong newcomers can understand the investigation.