# Contributing Guidelines

Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
documentation, we greatly value feedback and contributions from our community.

Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
information to effectively respond to your bug report or contribution.


## Reporting Bugs/Feature Requests

We welcome you to use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:

* A reproducible test case or series of steps
* The version of our code being used
* Any modifications you've made relevant to the bug
* Anything unusual about your environment or deployment


## Development Setup

### Windows

The following git setting is required when working on Windows:

```powershell
git config --global core.longpaths true
git config --global core.autocrlf false
```

- **`core.longpaths`** — the repository contains file paths that exceed Windows' default 260-character limit (inside the `aws-sdk-java-v2` submodule).

Run this command once before cloning (or before initializing submodules if you have already cloned).

## Contributing via Pull Requests
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:

1. You are working against the latest source on the *main* branch.
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.

To send us a pull request, please:

1. Fork the repository.
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
3. Ensure local tests pass.
4. Commit to your fork using clear commit messages (see [Commit Message Guidelines](#commit-message-guidelines) below).
5. Send us a pull request, answering any default questions in the pull request interface.
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

### Code Style & Linting

Ensure your changes pass all linters. The CI will enforce these checks automatically.

**Rust**

```bash
# Format all Rust code
cargo fmt --all

# Run Clippy (warnings are treated as errors in CI)
cargo clippy --workspace
```

**Python** (scripts in `iam-policy-autopilot-policy-generation/scripts/`)

```bash
# Lint
ruff check .

# Format
ruff format .

# Check formatting without modifying files (as CI does)
ruff format --check .
```

Ruff is configured in [`pyproject.toml`](pyproject.toml) at the repository root. Install it with `pip install ruff` or via your package manager.

### Commit Message Guidelines

We follow [Conventional Commits](https://www.conventionalcommits.org/) for commit messages. This helps with automated changelog generation and makes the commit history more readable.

**Format:**
```
<type>: <description>

[optional body]

[optional footer]
```

**Types:**
- `feat:` - New feature
- `fix:` - Bug fix
- `docs:` - Documentation changes
- `chore:` - Maintenance tasks, dependency updates
- `test:` - Adding or updating tests
- `refactor:` - Code refactoring without changing functionality
- `perf:` - Performance improvements
- `ci:` - CI/CD configuration changes
- `build:` - Compilation/build related changes
- `style:` - Formatting changes
- `revert:` - Reverted commits

**Breaking Changes:**

For breaking changes, append `!` after the type or add `BREAKING CHANGE:` in the footer:

```bash
feat!: change CLI argument format for generate-policies command
```

**Examples:**
```bash
feat: add support for CloudFormation policy generation
fix: resolve parsing error for multi-line AccessDenied messages
docs: update installation instructions in README
chore: bump aws-sdk-iam to version 1.90.0
test: add integration tests for MCP server
feat!: remove deprecated --legacy-format flag
```

GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).


## Finding contributions to work on
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.


## Code of Conduct
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
opensource-codeofconduct@amazon.com with any additional questions or comments.


## Security issue notifications
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.


## Licensing

See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.