skills.rest
ealvar3z
ealvar3zCOMMUNITY
Explore all skills by this author →
Website𝕏@bruno_jenkinzGitHub

auditing-code-quality

Audit Go code against SOLID principles and best practices, generating a unified report and Taskwarrior tasks.

Updated Dec 3, 2023
Search Tags:#quality assurance#software design#code audit#solid principles#architecture review#go best practices
One-click install
npx skills add https://github.com/ealvar3z/dotfiles --skill auditing-code-quality
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: auditing-code-quality
Source: https://github.com/ealvar3z/dotfiles/tree/main/prompts/skills/auditing-code-quality
Command: npx skills add https://github.com/ealvar3z/dotfiles --skill auditing-code-quality

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the need for a thorough evaluation of code quality by integrating multiple specialized audits, ensuring adherence to best practices at both the code and architectural levels.

Core Features & Use Cases

  • Multi-faceted Auditing: Combines checks for Go best practices, common Go mistakes, SOLID principles, and system-level architecture principles.
  • Automated Task Creation: Generates actionable tasks in Taskwarrior for identified issues.
  • Use Case: A development team can use this skill to perform a full health check on a new microservice before it's deployed, identifying potential design flaws and areas for improvement.

Quick Start

Run a full code quality audit on the provided codebase.

Frequently Asked Questions about auditing-code-quality

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

FAQPage Schema
How do I perform a comprehensive code quality audit for a Go codebase?▼

A comprehensive code audit analyzes your Go codebase against SOLID principles, system-level architecture, and Go best practices. It orchestrates multiple specialized checks to generate a unified report and actionable tasks.

What does a code architecture review based on SOLID principles cover?▼

An architecture review based on SOLID principles evaluates your software design for structural flaws and best practice adherence. It checks standard SOLID rules, beyond-solid principles, and Go-specific architectural patterns.

Can I use this code audit to check a microservice before deployment?▼

Yes, you can use this code audit to run a full health check on a new microservice before deployment. It identifies potential design flaws and areas for improvement across code and architecture.

How do I generate actionable tasks from identified code quality issues?▼

You generate actionable tasks from code quality issues by integrating audit results with Taskwarrior task management. The audit automatically creates actionable tasks for issues found during the Go and architecture reviews.

Does the code audit check for common Go mistakes and best practices?▼

Yes, the code audit checks for common Go mistakes and Go best practices. It sequentially invokes specialized checks to evaluate your codebase against these specific Go standards alongside SOLID and architecture principles.

Related Skills

Explore More Software Engineering Skills→
brandon-frysliebrandon-fryslie
4

spec-audit

Compare spec files against source code and generate audit reports.

Community
Advanced
ealvar3zealvar3z

taskwarrior-task-management

Manage Taskwarrior tasks scoped to the current Git project.

Community
Intermediate
ealvar3zealvar3z

100-go-mistakes

Audit Go code for 100 common mistakes from the book.

Community
Intermediate
CapplequoppeCapplequoppe

code-architecture

Provide software architecture guidelines covering DDD, SOLID, Clean Code, and Clean Architecture.

Community
Basic