coding-guidelines

Provide behavioral and procedural guidelines for safer coding and code reviews.

Updated Jun 11, 2019

Search Tags:#code review #best practices #software development #coding #guidelines

Ready to run

npx skills add https://github.com/Sanmoo/dotfiles --skill coding-guidelines-sanmoo

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: coding-guidelines
Source: https://github.com/Sanmoo/dotfiles/tree/main/opencode/.config/opencode/skills/coding-guidelines
Command: npx skills add https://github.com/Sanmoo/dotfiles --skill coding-guidelines-sanmoo

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

It provides behavioral guidelines to help developers write safer, clearer, and more reliable code, reducing mistakes and misunderstandings during implementation.

Core Features & Use Cases

Guideline Framework: Offers structured principles for thoughtful coding practices.
Use Cases: Ideal for developer teams aiming to improve code quality, review processes, and refactoring standards.
Example: Use this to reinforce disciplined coding habits during code reviews or new feature development.

Quick Start

Ask the AI to review a code snippet against these coding guidelines to identify potential issues or improvements.

Frequently Asked Questions about coding-guidelines

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

FAQPage Schema

What are coding guidelines for improving software development quality?▼

Coding guidelines provide behavioral and procedural principles to minimize common mistakes and ensure cautious, disciplined software development. They offer a structured framework to guide safe coding behaviors during implementation and refactoring.

How do I use coding guidelines to review a code snippet?▼

To review a code snippet against coding guidelines, ask the AI to evaluate it using structured behavioral principles. This identifies potential issues and improvements to ensure cautious and disciplined development practices were followed.

When do I need to apply behavioral coding guidelines during development?▼

Apply behavioral coding guidelines during coding, reviewing, and refactoring tasks. They are needed whenever you aim to minimize common mistakes, improve code quality, and reinforce disciplined development habits across various programming tasks.

Are coding guidelines suitable for team code review processes?▼

Yes, coding guidelines are ideal for developer teams aiming to improve code review processes. They provide clear behavioral principles that help reduce misunderstandings and ensure safe, reliable code implementation across the team.

What is the best way to enforce safe coding behaviors during refactoring?▼

The best way to enforce safe coding behaviors during refactoring is to apply clear, structured coding guidelines. These behavioral principles minimize common mistakes and improve overall code quality and reliability.