sprint-review

Generate a markdown changelog from GitHub pull requests grouped into Features and Fixes.

386|30|Updated Oct 9, 2024
One-click install
npx skills add https://github.com/rhesis-ai/rhesis --skill sprint-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sprint-review
Source: https://github.com/rhesis-ai/rhesis/tree/main/.cursor/skills/sprint-review
Command: npx skills add https://github.com/rhesis-ai/rhesis --skill sprint-review

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires jq, and includes scripts (resource) components.

What problem does it solve?

This Skill automates the creation of a sprint review changelog by summarizing GitHub pull requests, saving significant time and effort in preparing for team meetings.

Core Features & Use Cases

  • Automated PR Collection: Gathers pull requests based on author and date range.
  • Categorization: Groups PRs into 'Features' and 'Fixes' for clarity.
  • Markdown Summary: Generates a well-formatted markdown document suitable for sprint reviews.
  • Use Case: After a two-week sprint, use this Skill to quickly generate a changelog detailing all new features and bug fixes merged by your team, ready to be presented in the sprint review meeting.

Quick Start

Generate a sprint review changelog for pull requests authored by me in the last two weeks.

Frequently Asked Questions about sprint-review

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

FAQPage Schema
How do I generate a sprint changelog from GitHub pull requests?

Generate a sprint changelog from GitHub pull requests by running a command that automatically collects PRs from the last two weeks, groups them into Features and Fixes, and outputs a formatted markdown summary for your sprint review.

Can I override the default time range when collecting pull requests for a sprint review?

Yes, you can override the default two-week time range for collecting pull requests. The sprint review changelog automatically detects a two-week window but accepts custom parameters to adjust the date range as needed.

Do I need jq installed to generate a markdown changelog from PRs?

Yes, you need jq installed to generate a markdown changelog from PRs. The skill requires the jq dependency to parse and process GitHub pull request data for categorization into Features and Fixes.

What is the best way to categorize merged GitHub pull requests for a sprint review meeting?

The best way to categorize merged GitHub pull requests for a sprint review is to use an automated tool that groups PRs into Features and Fixes, consolidates similar items, and formats the output into a markdown document ready for presentation.

How does automatic user detection work when summarizing GitHub pull requests?

Automatic user detection works by identifying the current authenticated GitHub user when summarizing pull requests. The skill detects your GitHub identity to filter and collect only the PRs you authored, which you can also manually override.

Why are my GitHub pull requests not appearing in the sprint review changelog?

GitHub pull requests may not appear in the sprint review changelog if they fall outside the default two-week time range, were not authored by the detected user, or if the jq dependency is not properly installed for data processing.