|
| 1 | +# Contributing |
| 2 | + |
| 3 | +Thank you for your interest in this project! This project is not accepting external contributions at this time. Please feel free to open issues for bug reports and feature requests. |
| 4 | + |
| 5 | +## Table of Contents |
| 6 | + |
| 7 | +- [Reporting Bugs](#reporting-bugs) |
| 8 | +- [Feature Requests](#feature-requests) |
| 9 | +- [Local Development](#local-development) |
| 10 | +- [Publishing your Change](#publishing-your-change) |
| 11 | +- [Security](#security) |
| 12 | + |
| 13 | +## Reporting Bugs |
| 14 | + |
| 15 | +- Before reporting bugs, please make sure you are on the latest version. |
| 16 | +- Go through existing issues and check no users have reported the same bug. |
| 17 | +- Submit a [GitHub Issue](https://github.com/aws/agent-toolkit-for-aws/issues/new?template=bug_report.yml) with detailed steps on how to reproduce this bug, as well as your system information such as your AI assistant (Claude Code, Codex, Kiro, etc.), its version, and operating system. |
| 18 | + |
| 19 | +## Feature Requests |
| 20 | + |
| 21 | +- Before submitting a feature request, please make sure you are on the latest version. |
| 22 | +- Go through existing issues and check no users have requested the same feature. |
| 23 | +- Submit a [GitHub Issue](https://github.com/aws/agent-toolkit-for-aws/issues/new?template=feature_request.yml) with a clear description of the feature and your use case. |
| 24 | + |
| 25 | +## Local Development |
| 26 | + |
| 27 | +1. Clone the repository: |
| 28 | + |
| 29 | + ```bash |
| 30 | + git clone https://github.com/aws/agent-toolkit-for-aws.git |
| 31 | + cd agent-toolkit-for-aws |
| 32 | + ``` |
| 33 | + |
| 34 | +2. Install [Mise](https://mise.jdx.dev/) and trust the repo config: |
| 35 | + |
| 36 | + ```bash |
| 37 | + mise trust |
| 38 | + mise install |
| 39 | + ``` |
| 40 | + |
| 41 | +3. Run the full build (lint + validate + security): |
| 42 | + |
| 43 | + ```bash |
| 44 | + mise run build |
| 45 | + ``` |
| 46 | + |
| 47 | +## Publishing your Change |
| 48 | + |
| 49 | +1. Create a new branch from `main`: |
| 50 | + |
| 51 | + ```bash |
| 52 | + git checkout main |
| 53 | + git pull origin main |
| 54 | + git checkout -b feat/your-feature-name |
| 55 | + ``` |
| 56 | + |
| 57 | +2. Make your changes and validate: |
| 58 | + |
| 59 | + ```bash |
| 60 | + mise run build |
| 61 | + ``` |
| 62 | + |
| 63 | +3. Commit and push: |
| 64 | + |
| 65 | + ```bash |
| 66 | + git add . |
| 67 | + git commit -m "feat: add descriptive commit message" |
| 68 | + git push -u origin feat/your-feature-name |
| 69 | + ``` |
| 70 | + |
| 71 | +4. Open a pull request against `main` using the [PR template](.github/pull_request_template.md). |
| 72 | + |
| 73 | +## Security |
| 74 | + |
| 75 | +If you discover a potential security issue, please notify AWS/Amazon Security via the [vulnerability reporting page](https://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue. |
0 commit comments