skills.rest
golemcloud
golemcloudOFFICIAL
Explore all skills by this author →
WebsiteGitHub

pre-pr-checklist

Automate pre-pull request checks for Rust projects using cargo make tasks.

1.5k|207|Updated Nov 24, 2023
Search Tags:#code quality#git#testing#checklist#rust#pr
One-click install
npx skills add https://github.com/golemcloud/golem --skill pre-pr-checklist-golemcloud
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: pre-pr-checklist
Source: https://github.com/golemcloud/golem/tree/main/.agents/skills/pre-pr-checklist
Command: npx skills add https://github.com/golemcloud/golem --skill pre-pr-checklist-golemcloud

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the pull request process by ensuring code quality, correct testing, and proper staging before submission, preventing common errors and saving review time.

Core Features & Use Cases

  • Automated Code Formatting and Linting: Runs cargo make fix to automatically correct code style and catch potential issues.
  • Targeted Test Execution: Guides you to run only the necessary test suites based on your changes, avoiding lengthy full test runs.
  • Artifact Regeneration: Provides commands to regenerate necessary files like OpenAPI specs or configuration structs.
  • Staging Verification: Reminds you to carefully review and stage only relevant files.
  • Use Case: Before submitting a change to the Golem worker executor, you can use this Skill to ensure cargo make fix passes, run cargo make worker-executor-tests, regenerate any affected WIT interfaces, and verify your staged files.

Quick Start

Run cargo make fix to format and lint your code, then execute the appropriate test command for your changes.

Frequently Asked Questions about pre-pr-checklist

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

FAQPage Schema
How do I automate pre-pull request checks for a Rust project?▼

Automate pre-pull request checks for a Rust project by running `cargo make fix` to format and lint code, then executing targeted test suites based on your code modifications. This ensures code quality and proper staging before submission.

What is the best way to run only the necessary Rust tests before submitting a PR?▼

The best way to run necessary Rust tests before a PR is to execute targeted test suites based on your specific code modifications, avoiding lengthy full test runs while ensuring relevant changes are properly validated.

How do I regenerate OpenAPI and WIT interfaces after modifying Rust code?▼

Regenerate OpenAPI specs, configurations, and WIT interfaces after modifying Rust code by executing specific artifact regeneration commands, ensuring generated files accurately reflect your latest code changes before staging.

Do I need cargo make to format and lint Rust code before a pull request?▼

Yes, you need cargo make to format and lint Rust code before a pull request. The Skill uses `cargo make fix` to automatically correct code style and catch potential issues during the pre-PR workflow.

Why should I verify staged files before creating a pull request?▼

Verify staged files before creating a pull request to ensure you only commit relevant modifications and avoid submitting unnecessary artifacts, preventing common errors and saving valuable code review time.

Can I use this pre-PR checklist for Golem worker executor changes?▼

Yes, you can use this pre-PR checklist for Golem worker executor changes. It ensures `cargo make fix` passes, runs `cargo make worker-executor-tests`, regenerates affected WIT interfaces, and verifies staged files.

Related Skills

Explore More Software Engineering Skills→
golemcloudgolemcloud
1.5k

modifying-wit-interfaces

Manage WIT definitions and synchronize them across Golem sub-projects.

Official
Intermediate
miko06miko06

ship

Automate code deployment with branch merge, tests, review, versioning, and pull requests.

Community
Advanced
jmaglyjmagly
175

test-sync

Detect orphaned tests and test-code misalignment between test suites and source code.

Community
Advanced
ahtavarasmusahtavarasmus
77

commit

Run cargo fmt, clippy, and tests before committing and pushing Rust code.

Community
Intermediate