Skip to content

Commit 1f85ff3

Browse files
author
Your Name
committed
Merge remote-tracking branch 'upstream/main' into docs/migrate-guides-to-docs-dir
2 parents a1860e7 + 8d22b19 commit 1f85ff3

2 files changed

Lines changed: 86 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# GitHub Copilot Custom Instructions for Agent Plugins for AWS
2+
3+
## Project Overview
4+
5+
This repository contains Agent Plugins for AWS that equip AI coding agents with the skills to help architects, deploy, and operate on AWS. The primary plugin is `deploy-on-aws`, which provides recommendations, cost estimates, and Infrastructure as Code generation.
6+
7+
## Technology Stack
8+
9+
- **Language**: Primarily TypeScript/JavaScript
10+
- **Framework**: Claude Code plugins
11+
- **Cloud Platform**: AWS
12+
- **Infrastructure as Code**: CDK and CloudFormation
13+
- **Tools**: MCP Servers (awsknowledge, awspricing, aws-iac-mcp)
14+
15+
## Code Organization
16+
17+
- `/plugins` - Plugin implementations
18+
- `/schemas` - Data schemas and type definitions
19+
- `/tools` - Utility tools and helpers
20+
- `/.github` - GitHub workflows and configuration
21+
- Root files: Configuration for linting (markdownlint, semgrep), security (gitleaks), and formatting (dprint)
22+
23+
## Development Practices
24+
25+
1. **Code Quality**: Uses pre-commit hooks, semgrep for security analysis, and gitleaks for secret detection
26+
2. **Documentation**: Comprehensive guides including DEVELOPMENT_GUIDE.md, CONTRIBUTING.md, TROUBLESHOOTING.md
27+
3. **Testing**: Follow existing test patterns in the codebase
28+
4. **Formatting**: Use dprint for code formatting consistency
29+
5. **Commit Signoff**: Web commit signoff required (git commit -S flag)
30+
31+
## Plugin Development Guidelines
32+
33+
- Follow the workflow pattern: Analyze → Recommend → Estimate → Generate → Deploy
34+
- MCP Servers provide: AWS documentation, pricing data, and IaC best practices
35+
- Skill triggers should be intuitive natural language phrases users would say
36+
- Always include cost estimation and confirmation steps before deployment
37+
- Generate infrastructure code with explanations and best practices
38+
39+
## Important Reminders for Copilot
40+
41+
1. **AWS Best Practices**: Recommend services aligned with AWS Well-Architected Framework
42+
2. **Cost Awareness**: Always estimate and display costs to users
43+
3. **User Confirmation**: Never deploy without explicit user confirmation
44+
4. **Multi-Agent Support**: Currently supports Claude Code; consider extensibility
45+
5. **Security**: Follow AWS security best practices and principle of least privilege
46+
6. **Documentation**: Provide clear explanations for architectural recommendations
47+
48+
## Key Files to Reference
49+
50+
- `README.md` - Project overview and installation instructions
51+
- `DEVELOPMENT_GUIDE.md` - How to create new plugins
52+
- `CONTRIBUTING.md` - Contribution guidelines
53+
- `TROUBLESHOOTING.md` - Common issues and solutions
54+
55+
## License
56+
57+
Apache-2.0 License - Ensure all contributions comply with this license
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
applyTo: ".github/CODEOWNERS"
3+
---
4+
5+
# CODEOWNERS file rules
6+
7+
Please verify this checklist to keep the `.github/CODEOWNERS` file following all five of these rules:
8+
9+
1. [ ] ONLY teams are used (no users)
10+
2. [ ] Teams MUST be vertically aligned across all lines with spaces (no tabs)
11+
3. [ ] Each section, "## section", MUST be alphabetically sorted (keep file patterns in order)
12+
4. [ ] Admins or maintainers must be first (if both separated by one space) - others follow with two spaces
13+
5. [ ] The file MUST follow this regular expression `^.github/CODEOWNERS *@awslabs/agent-plugins-admins$`
14+
15+
EXAMPLE:
16+
17+
```.github/CODEOWNERS
18+
README.md @awslabs/agent-plugins-admins @awslabs/agent-plugins-maintainers @awslabs/otherteams
19+
20+
## Plugins (alphabetically listed)
21+
22+
plugins/a @awslabs/agent-plugins-maintainers @awslabs/a-team
23+
plugins/d @awslabs/agent-plugins-maintainers @awslabs/a-d-group
24+
plugins/z @awslabs/agent-plugins-maintainers @awslabs/the-z-team
25+
26+
## File must end with CODEOWNERS file
27+
28+
.github/CODEOWNERS @awslabs/agent-plugins-admins
29+
```

0 commit comments

Comments
 (0)