fla-mr-readiness

Check pull requests against CONTRIBUTING guidelines and PR body format.

5.5k|643|Updated Dec 20, 2023

Search Tags:#workflow #code review #checklist #pull request #repository management

Ready to run

npx skills add https://github.com/fla-org/flash-linear-attention --skill fla-mr-readiness

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: fla-mr-readiness
Source: https://github.com/fla-org/flash-linear-attention/tree/main/.agents/skills/fla-mr-readiness
Command: npx skills add https://github.com/fla-org/flash-linear-attention --skill fla-mr-readiness

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill provides a structured checklist and workflow to ensure that all requirements are met before opening a pull request in the FLA repository.

Core Features & Use Cases

Pre-flight Checklist: Ensures code style, test plan, benchmark evidence, and PR body structure are in place.
Change Scope Confirmation: Helps confirm the scope of the change and check for duplicate work.
Test Execution: Guides the execution of dependent tests and the inclusion of performance evidence.
PR Body Structure: Suggests a structured format for the PR body to clearly communicate changes.

Quick Start

Run the fla-mr-readiness skill to prepare your MR/PR in the FLA repository.

Frequently Asked Questions about fla-mr-readiness

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

FAQPage Schema

How do I prepare a pull request for the Flash Linear Attention repository?▼

To prepare a pull request in the Flash Linear Attention repository, run the readiness workflow to verify code style, execute local tests, gather benchmark evidence, and structure the PR body according to CONTRIBUTING guidelines.

What should be included in a FLA pull request checklist?▼

A FLA pull request checklist must include code style verification, a defined test plan, local test execution results, benchmark evidence, and a structured PR body communicating the change scope clearly.

Do I need to run tests locally before submitting a PR to the FLA repository?▼

Yes, local execution of tests is required before submitting a PR. The readiness workflow guides you through running dependent tests and including performance evidence to ensure compliance.

How do I check for duplicate work before opening a repository management pull request?▼

The readiness workflow includes a change scope confirmation step that helps you review existing repository management efforts and verify your pull request does not introduce duplicate work.

What is the best way to format a pull request body for FLA contributions?▼

The best way to format a pull request body is using the suggested structured format, which clearly communicates changes, outlines the test plan, and provides benchmark evidence required by the FLA repository.

Why does my FLA pull request fail the readiness check?▼

Your pull request fails the readiness check if it lacks local test execution, benchmark evidence, proper code style, or a structured PR body required by the repository's CONTRIBUTING guidelines.