Project Rules & Standards

This folder contains project-specific coding standards, conventions, and reference documentation.

📋 Available Rules

• docstring-standards.md - Python docstring format and requirements
• markdown-standards.md - Markdown authoring standards and README best practices
• output-format.md - Format for execution logs and reports
• error-resolution-kb.md - Knowledge base of common errors and solutions

🎯 Purpose

Rules in this folder ensure: - Consistent code quality across the project - Standardized documentation - Knowledge retention (error KB) - AI assistant compliance (both Claude and Copilot)

✏️ Customization

This folder is meant to be customized for your specific project needs:

• Modify docstring standards to match your team's preferences
• Add project-specific error patterns to the KB
• Extend output format for custom reporting needs

🤖 AI Assistant Integration

Both Claude Code and GitHub Copilot reference these rules when: - Generating code (follows docstring standards) - Creating logs (follows output format) - Encountering errors (updates and references error KB)

🔗 Related Documentation

• Master Workflow
• TDD Workflow
• Instructions

---

Template Note: Start with the provided defaults and customize as your project evolves.