Skip to content

StephaneZ/kiro-steering-docs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

59 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kiro Steering Documents

A community-driven collection of reusable steering documents for Kiro. Discover, share, and contribute patterns that enhance your development workflow.

Quick Navigation

Browse by Category

Explore steering documents organized by functional area:

  • Agents - Specialized Kiro agent personas and workflows

  • Code Quality - Formatting, linting, and code standards

  • Testing - Test coverage and quality standards

  • Security - Security best practices and vulnerability prevention

  • Frameworks - Framework-specific patterns and conventions

  • Workflows - CI/CD, Git hooks, and automation

Search by Tag

Find documents by technology, purpose, or use case. See TAGS.md for the complete tag taxonomy.

Languages

Purposes

Tools & Frameworks

All Documents

Comprehensive searchable index of all available steering documents:

Agents

Document Description Tags
BMAD Spec Converter Transform BMAD planning documents into formal Kiro specifications agent, bmad, specs, requirements, property-based-testing

Code Formatting

Document Description Tags
Bash Scripting Safe Bash scripts with error handling and quoting bash, shell, scripting, linux
CSS Formatting Property ordering, naming conventions, consistent spacing css, scss, formatting, styles
Dockerfile Optimized Dockerfiles with layer caching and security docker, dockerfile, containers, devops
GraphQL Schema Well-structured GraphQL schemas with consistent naming graphql, api, schema, formatting
JavaScript Formatting Semicolons, quotes, indentation, import organization javascript, formatting, eslint, code-generation
JSON Formatting Consistent indentation, key ordering, proper formatting json, formatting, config
Markdown Formatting Formatting standards, heading hierarchy, list formatting markdown, documentation, formatting
Python Formatting PEP 8 compliance, import organization, naming conventions python, formatting, pep8, code-generation
SQL Formatting Readable SQL queries with proper structure sql, database, formatting, queries
Terraform Configuration Well-organized Terraform with proper resource naming terraform, iac, infrastructure, devops
TypeScript Formatting Type annotations, interfaces, import organization typescript, formatting, types, code-generation
YAML Formatting Clean YAML with proper indentation yaml, formatting, config, devops

Code Quality

Document Description Tags
Code Review Standards Code review best practices and standards code-review, quality, best-practices
Database Query Patterns Database query organization and optimization database, sql, query-patterns
Error Handling Standards Error handling patterns and best practices error-handling, exceptions, quality
Logging Standards Logging patterns and best practices logging, debugging, observability

Frameworks

Document Description Tags
Django Patterns Django project structure and patterns django, python, framework, web
FastAPI Patterns FastAPI endpoint structure and patterns fastapi, python, api, framework
Node.js/Express Patterns Express route organization and middleware nodejs, express, javascript, api
React Component Patterns React component structure and hooks react, javascript, components, frontend
Vue Component Patterns Vue composition API and component patterns vue, javascript, components, frontend

Security

Document Description Tags
Security Best Practices Secure code with input validation and vulnerability prevention security, validation, best-practices, vulnerabilities

Testing

Document Description Tags
Testing Best Practices Test coverage and quality standards testing, quality, best-practices

Workflows

Document Description Tags
API Development Patterns API design and development patterns api, rest, development, patterns
Environment Config Environment configuration management config, environment, deployment
Git Commit Standards Git commit message conventions git, version-control, commits
Logging Standards Application logging patterns logging, debugging, observability

Tag Reference

JavaScript

Documents tagged with javascript:

TypeScript

Documents tagged with typescript:

Python

Documents tagged with python:

CSS

Documents tagged with css:

JSON

Documents tagged with json:

Markdown

Documents tagged with markdown:

Formatting

Documents tagged with formatting:

Code Generation

Documents tagged with code-generation:

Documentation

Documents tagged with documentation:

ESLint

Documents tagged with eslint:

Testing

Documents tagged with testing:

React

Documents tagged with react:

Vue

Documents tagged with vue:

Django

Documents tagged with django:

FastAPI

Documents tagged with fastapi:

Express

Documents tagged with express:

Git

Documents tagged with git:

API Development

Documents tagged with api:

Agents

Documents tagged with agent:

Coming Soon

We're actively expanding the repository based on community feedback. Have a suggestion? Open an issue!

Want to contribute one of these? Check out our contribution guidelines!

How to Use

Quick Start

  1. Browse: Use the category navigation or tag search to find documents

  2. Copy: Download or copy the steering document to your .kiro/steering/ directory

  3. Use: Kiro automatically applies the steering rules when generating code

  4. Customize: Modify the document to match your team's preferences

Installation Example

# Copy a steering document to your project
cp code-formatting/languages/javascript-formatting.md .kiro/steering/

# Or copy multiple documents
cp code-formatting/{languages,markup,data-formats,infrastructure}/*.md .kiro/steering/

Finding the Right Document

By Language: Use the tag reference to find all documents for your language

By Purpose: Browse practices to find documents by functional area

By Framework: Check the frameworks practices for framework-specific patterns

Combining Documents

Steering documents work together. A typical setup might include:

.kiro/steering/
├── javascript-formatting.md    # Base language formatting
├── react-patterns.md           # Framework-specific patterns
├── test-coverage.md            # Testing standards
└── git-hooks.md                # Workflow automation

Contributing

We welcome contributions! Share your steering documents to help the community.

How to Contribute

  1. Fork this repository

  2. Choose the appropriate category for your document

  3. Use the template for consistency

  4. Add proper tags and metadata

  5. Submit a pull request

See our contribution guidelines for detailed instructions.

What Makes a Good Contribution

  • Focused: Addresses a specific need or pattern

  • Tested: Works in real projects

  • Documented: Clear examples and usage instructions

  • Tagged: Proper tags for discoverability

Adding Tags

When contributing, include relevant tags:

  • Language tags: javascript, python, typescript, etc.

  • Purpose tags: formatting, testing, security, etc.

  • Tool tags: eslint, prettier, git, etc.

  • Framework tags: react, vue, django, etc.

Documentation

Comprehensive guides for creating and contributing steering documents:

For Contributors

For Reviewers

Templates and Tools

Related Resources

  • Tag Taxonomy - Complete tag reference and guidelines

  • Templates - Templates for creating new steering documents

  • Examples - Complete example setups (coming soon)

  • Tools - Validation and utility scripts

  • Contribution Guide - Detailed contribution instructions

  • Roadmap - Project roadmap and future plans

  • Code of Conduct - Community guidelines

License

This project is licensed under the MIT License - see the LICENSE file for details.

Community

  • Issues: Report problems or request new steering documents

  • Discussions: Share ideas and ask questions

  • Pull Requests: Contribute your own steering documents

  • Security: See SECURITY.md for reporting vulnerabilities

  • Maintainers: See MAINTAINERS.md for maintainer guidelines


Note: This is a community-driven project. Steering documents are provided as-is and should be reviewed and tested before use in production environments.

About

Community collection of Kiro steering documents

Resources

License

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 80.7%
  • Python 19.3%