Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ We welcome contributions of all kinds - from bug reports and feature requests to
- πŸ› **Found a bug?** β†’ [Create an Issue](https://github.com/localstack-dotnet/localstack-dotnet-client/issues/new)
- πŸ’‘ **Have an idea?** β†’ [Start a Discussion](https://github.com/localstack-dotnet/localstack-dotnet-client/discussions)
- ❓ **Need help?** β†’ [Q&A Discussions](https://github.com/localstack-dotnet/localstack-dotnet-client/discussions/categories/q-a)
- 🚨 **Security issue?** β†’ See our [Security Policy](.github/SECURITY.md)
- 🚨 **Security issue?** β†’ See our [Security Policy](SECURITY.md)
- πŸ”§ **Ready to code?** β†’ [Submit a Pull Request](https://github.com/localstack-dotnet/localstack-dotnet-client/compare)

## 🀝 Code of Conduct

This project follows the [.NET Foundation Code of Conduct](.github/CODE_OF_CONDUCT.md). By participating, you're expected to uphold this code. Please report unacceptable behavior to [localstack.dotnet@gmail.com](mailto:localstack.dotnet@gmail.com).
This project follows the [.NET Foundation Code of Conduct](CODE_OF_CONDUCT.md). By participating, you're expected to uphold this code. Please report unacceptable behavior to [localstack.dotnet@gmail.com](mailto:localstack.dotnet@gmail.com).

## πŸ“ Contributor License Agreement (CLA)

Expand All @@ -25,15 +25,15 @@ This project follows the [.NET Foundation Code of Conduct](.github/CODE_OF_CONDU
We maintain a **dual-track versioning strategy**:

- **v2.x (AWS SDK v4)** - Active development on [`master`](https://github.com/localstack-dotnet/localstack-dotnet-client/tree/master) branch
- **v1.x (AWS SDK v3)** - Long-term support on [`sdkv3-lts`](https://github.com/localstack-dotnet/localstack-dotnet-client/tree/sdkv3-lts) branch (maintained until July 2026)
- **v1.x (AWS SDK v3)** - The [`sdkv3-lts`](https://github.com/localstack-dotnet/localstack-dotnet-client/tree/sdkv3-lts) branch preserves published releases but is no longer supported; its maintenance window ended in July 2026. See the [security policy](SECURITY.md).

When contributing, please specify which version track your contribution targets.
New changes target v2.x on `master`. The v1.x branch is not accepting maintenance fixes.

## πŸš€ Getting Started

### Prerequisites

- [.NET SDK 8.0+](https://dotnet.microsoft.com/download) (for development)
- A [.NET SDK](https://dotnet.microsoft.com/download) compatible with the repository's [`global.json`](../global.json) (for development)
- [Docker](https://docs.docker.com/get-docker/) (for LocalStack testing)
- [Git](https://git-scm.com/downloads)
- IDE: [Visual Studio](https://visualstudio.microsoft.com/), [Rider](https://www.jetbrains.com/rider/), or [VS Code](https://code.visualstudio.com/)
Expand Down Expand Up @@ -61,16 +61,17 @@ When contributing, please specify which version track your contribution targets.
./build.sh
```

On Unix, the Cake initialization task changes your global Git `core.autocrlf` setting. Read the [quality gates](../docs/engineering/quality-gates.md) before using the script on a shared development machine.

3. **Run Tests**

```bash
# All tests (requires Docker for functional tests)
# Default unit and client-construction tests (functional tests are skipped)
.\build.ps1 --target tests

# Unit/Integration tests only
.\build.ps1 --target tests --skipFunctionalTest true
```

Functional tests require LocalStack containers. The Cake opt-in task attempts to remove **every** Docker container returned by `docker ps --all`, not only this project's containers. Use an isolated Docker daemon before opting in; see [quality gates](../docs/engineering/quality-gates.md).

## πŸ› Reporting Issues

### Before Creating an Issue
Expand Down Expand Up @@ -124,7 +125,7 @@ We love new ideas! Here's how to suggest features:
3. **Test thoroughly**

```bash
# Run all tests
# Run the default suite (functional tests skipped)
./build.sh --target tests

# Test specific scenarios with LocalStack
Expand All @@ -143,7 +144,7 @@ We love new ideas! Here's how to suggest features:
- Use our [PR Template](https://github.com/localstack-dotnet/localstack-dotnet-client/compare)
- Provide clear description of changes
- Link related issues
- Specify target version track (v1.x or v2.x)
- Target the supported v2.x line

### Code Quality Standards

Expand Down Expand Up @@ -201,6 +202,6 @@ Contributors are recognized in:

---

**By contributing to this project, you agree to abide by our [Code of Conduct](.github/CODE_OF_CONDUCT.md) and understand that your contributions will be licensed under the MIT License.**
**By contributing to this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md) and understand that your contributions will be licensed under the MIT License.**

Thank you for making LocalStack .NET Client better! πŸš€
4 changes: 3 additions & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,12 @@ A clear and concise description of what you expected to happen.

**LocalStack.Client Version:**

- [ ] v1.x (AWS SDK v3) - LTS Branch
- [ ] v1.x (AWS SDK v3) - Unsupported historical release
- [ ] v2.x (AWS SDK v4) - Current Branch
- Version:

The v1.x maintenance window ended in July 2026; new fixes target v2.x. See the [security policy](https://github.com/localstack-dotnet/localstack-dotnet-client/blob/master/.github/SECURITY.md).

**LocalStack Information:**

- LocalStack Version:
Expand Down
10 changes: 5 additions & 5 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ Provide a clear and concise description of the changes.

## 🎯 Target Version Track

- [ ] v1.x (AWS SDK v3) - LTS Branch (`sdkv3-lts`)
- [ ] v2.x (AWS SDK v4) - Current Branch (`master`)
- [ ] Both versions (requires separate PRs)
- [ ] v2.x (AWS SDK v4) - Supported branch (`master`)

The v1.x / AWS SDK v3 line is no longer supported; do not target new fixes to `sdkv3-lts`. See the [security policy](https://github.com/localstack-dotnet/localstack-dotnet-client/blob/master/.github/SECURITY.md).

## πŸ§ͺ Testing

Expand Down Expand Up @@ -98,6 +98,6 @@ If applicable, add screenshots or code examples showing the changes in action.

By submitting this pull request, I confirm that:

- [ ] I have read and agree to the project's [Code of Conduct](.github/CODE_OF_CONDUCT.md)
- [ ] I understand that this contribution may be subject to the [.NET Foundation CLA](.github/CONTRIBUTING.md)
- [ ] I have read and agree to the project's [Code of Conduct](https://github.com/localstack-dotnet/localstack-dotnet-client/blob/master/.github/CODE_OF_CONDUCT.md)
- [ ] I understand that this contribution may be subject to the [.NET Foundation CLA](https://github.com/localstack-dotnet/localstack-dotnet-client/blob/master/.github/CONTRIBUTING.md)
- [ ] My contribution is licensed under the same terms as the project (MIT License)
16 changes: 8 additions & 8 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,20 @@

## Supported Versions

We maintain a dual-track versioning strategy with different support levels for each track. Security patches are released based on the CVSS v3.0 Rating and version track:
Security patches are released for the supported v2.x line according to the CVSS v3.0 rating below. Previously published v1.x packages remain available, but availability does not mean the line is still maintained.

### Version Tracks

- **v2.x (AWS SDK v4)**: Active development on [master branch](https://github.com/localstack-dotnet/localstack-dotnet-client/tree/master)
- **v1.x (AWS SDK v3)**: Long-term support (LTS) on [sdkv3-lts branch](https://github.com/localstack-dotnet/localstack-dotnet-client/tree/sdkv3-lts), maintained until **July 2026**
- **v1.x (AWS SDK v3)**: The [sdkv3-lts branch](https://github.com/localstack-dotnet/localstack-dotnet-client/tree/sdkv3-lts) is no longer supported. Its announced maintenance window ended in **July 2026**. We do not plan further v1.x bug fixes, security patches, or service updates; migrate to v2.x. The upstream [AWS SDK for .NET v3 reached end-of-support on June 1, 2026](https://aws.amazon.com/blogs/devops/announcing-the-end-of-support-for-the-aws-sdk-for-net-v3/).

### Security Patch Policy

| CVSS v3.0 | v2.x (Current) | v1.x (LTS) |
| --------- | -------------- | ---------- |
| 9.0-10.0 | βœ… All releases within previous 3 months | βœ… Latest LTS release |
| 4.0-8.9 | βœ… Most recent release | βœ… Latest LTS release |
| < 4.0 | ⚠️ Best effort | ❌ No patches (upgrade recommended) |
| CVSS v3.0 | v2.x (Current) |
| --------- | -------------- |
| 9.0-10.0 | βœ… All releases within previous 3 months |
| 4.0-8.9 | βœ… Most recent release |
| < 4.0 | ⚠️ Best effort |

## Reporting a Vulnerability

Expand Down Expand Up @@ -59,4 +59,4 @@ Security updates will be released as soon as possible after a vulnerability is c

## Comments on this Policy

If you have suggestions on how this process could be improved, please submit a pull request or open an issue to discuss.
If you have suggestions on how this process could be improved, please submit a pull request or open an issue to discuss.
214 changes: 0 additions & 214 deletions .github/copilot-instructions.md

This file was deleted.

Loading
Loading