no-slop

A coding standard designed to reduce sloppiness in AI coding agents and improve code quality across projects.

Overview

This repository provides agent.md - a comprehensive set of coding standards and guidelines specifically crafted to help AI coding agents generate cleaner, more maintainable, and professional code. The rules emphasize simplicity, clarity, and best practices while avoiding common pitfalls that lead to "sloppy" code.

Files

• agent.md - English version of the coding standards
• agent.zh-cn.md - Chinese (Simplified) translation of the coding standards
• README.md - This file
• README.zh-cn.md - Chinese (Simplified) translation of this file

Key Principles

The guidelines are built around these core principles:

1. YAGNI (You Ain't Gonna Need It) - Avoid implementing features that aren't immediately needed
2. KISS (Keep It Simple, Stupid) - Prioritize simple, straightforward solutions
3. Clear Ownership - Always define who owns logic, resources, and information
4. Clean Data Flow - Explicitly map data suppliers, consumers, and potential leaks

How to Apply These Standards

Cursor

1. Create folder named .cursor/rules in your project root.
2. Copy the agent.md to the folder.
3. Alternatively, Create AGENTS.md and copy agent.md content to the file.

GitHub Copilot

1. In your project, create a .github/copilot-instructions.md file.
2. Copy the agent.md content to the file.

Claude Code

1. Create CLAUDE.md in your project root.
2. Copy the agent.md content to the file.

Other tools

1. Follow the manual from your provider.
2. Or just ask the agent to follow agent.md.

License

This project is dedicated to reducing code sloppiness everywhere. Feel free to use these standards in your projects and share them with your AI coding assistants.

Support

For questions or improvements:

• Open an issue for discussion
• Submit pull requests for standard updates
• Share your experiences applying these standards with different AI tools