Erold contributing critical
How to Write Guidelines
Learn the structure, format, and best practices for writing guidelines that help developers and AI agents build better software.
- Difficulty
- beginner
- Read time
- 1 min read
- Version
- v1.0.0
- Confidence
- established
- Last updated
Quick Reference
When writing a guideline for erold.guide, follow this structure: YAML frontmatter with required fields (title, slug, topic, category, version, description, tags, author, difficulty), then markdown content with sections for Why, When to Apply, Code Examples, Anti-patterns, and Summary.
Use When
- Contributing a new guideline to erold.guide
- Updating an existing guideline
- Reviewing guideline submissions
Skip When
- Reading guidelines as a consumer
- Using the API to fetch guidelines
How to Write Guidelines
Learn the structure, format, and best practices for writing guidelines that help developers and AI agents build better software.