code-quality-workflow

Run yarn scripts for type checking, formatting, linting, and testing.

18|8|Updated May 31, 2023
One-click install
npx skills add https://github.com/jpmorgan-payments/embedded-finance --skill code-quality-workflow
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-quality-workflow
Source: https://github.com/jpmorgan-payments/embedded-finance/tree/main/.github/skills/code-quality-workflow
Command: npx skills add https://github.com/jpmorgan-payments/embedded-finance --skill code-quality-workflow

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill enforces mandatory code quality checks, ensuring all code adheres to established standards before it is committed, preventing integration issues and maintaining a high level of code integrity.

Core Features & Use Cases

  • Automated Checks: Runs type checking, formatting, linting, and unit tests.
  • Error Correction Guidance: Provides specific commands and examples for fixing common errors.
  • Use Case: Before committing new features or bug fixes, run this workflow to automatically format your code, check for type errors, and ensure all tests pass, guaranteeing a clean and stable codebase.

Quick Start

Run the code-quality-workflow skill to format, test, and ensure your code is ready for commit.

Frequently Asked Questions about code-quality-workflow

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

FAQPage Schema
How do I automate code quality checks before committing changes?

Automate code quality checks by running a workflow that enforces type checking, formatting, linting, and testing. This ensures all code adheres to established standards before it is committed, preventing integration issues.

Does this code quality workflow run formatting and linting automatically?

Yes, the code quality workflow runs automated type checking, formatting, and linting. It applies specific yarn scripts to validate and correct code changes within the embedded-components package.

What is the best way to enforce type checking and unit tests for embedded components?

The best way to enforce type checking and unit tests is using an automated workflow that requires execution of specific yarn scripts. This guarantees a clean and stable codebase before committing new features or bug fixes.

How do I fix linting and formatting errors flagged by automated code checks?

To fix linting and formatting errors, follow the error correction guidance provided by the workflow. It offers specific commands and examples to correct common issues and ensure your code passes validation.

Can I use this workflow to validate code changes outside the embedded-components package?

No, the workflow specifically applies mandatory quality checks to code changes within the embedded-components package. It enforces formatting, linting, and testing standards for that scope before commits.