为Amazon EKSBlueprints for CDK项目贡献代码指南

由 AWS 客户、合作伙伴及 AWS 内部提供的开源项目（注：项目指代开源代码库repo）

图片来源：Amazon Bedrock

The Amazon EKS 蓝图 CDK 仓库 包含 [eks-blueprints](https://www.npmjs.com/package/@aws-quickstart/eks-blueprints) NPM 模块的源代码，。AWS 客户、合作伙伴和内部 AWS 团队可以使用它来配置和管理完整的 EKS 集群环境，并进行初始化，以部署和操作所需的工作负载。

我现在已经是这个仓库的贡献者了，在这篇博客里，我将分享一些如何为这个项目做贡献的建议。

以下说明无论拉取请求是从 fork 还是分支提交都适用。如果你是外部贡献者，你应该只通过你的 fork 提交拉取请求。

1. 确保你的集成开发环境（IDE）只对修改过的行进行格式化。提交完全格式化的文件会很难审查，这样会被拒绝。
2. 缩进大小为4个空格（有些人可能不使用VSCode作为IDE）。
3. 以下命令不应有任何错误或警告：

运行：npm i 回车
运行：make build 回车
运行：make lint �回车
运行：make run-test 回车
运行：cdk list 回车

项目附带的持续集成(CI)系统将运行examples目录下的所有栈实例来进行端到端集成测试。

目前它是这么工作的：

• 人工维护人员审核 PR 代码以确保其无恶意。
• 如果代码被认为可信且维护人员希望运行端到端（E2E）测试，他们可以在 PR 上评论 /do-e2e-tests。这将触发构建和测试。任何关于状态的信息都需要通过 AWS 维护人员获取。
• 如果作业成功，CI 机器人会自动批准 PR。如果失败，它会要求进行相应的更改。详细失败信息需手动告知外部贡献者。
• 目前，shapirov103、kcoleman731 和 askulkarni2 有权调用机器人。

外部贡献者请注意:

1. 创建一个仓库的分支。我的分支在这里 这里。
2. 提交一个 问题，描述具体信息。例如，下面是我问题中的一个示例。

    描述功能特性  

    Kubernetes 版本 1.30 的 Lambda 层资产文件已从 cdklabs/awscdk-asset-kubectl 仓库 #838 发布，因此我们需要更新蓝图以使用该层资产文件  

    用例  

    目前通过 .of 方法指定版本，但如果 CDK 蓝图能够提供支持会更方便  

    致谢  

     我可能能够实现这个功能请求  
    所用的 CDK 版本  

    2.145.0 (build fdf53ba)  

    EKS 蓝图版本  

    1.14.1  

    Node.js 版本  

    v20.11.0  

    环境详情（如操作系统名称及版本）  

    macOS 系统

3. 按照上述提到的，实施改动并完成全链路测试。

所有本地测试都成功完成了

1. 提交合并请求

一旦你的代码准备就绪，提交带有清晰功能描述的PR，并提供测试覆盖率和验证说明。

修复的 Issue #（如果有）: 修复 #1021

变更描述:  
添加了对 1.30 的测试  
更新 cdk 版本到 2.145.0  
清理了从 1.25 到 1.30 的旧版本

通过提交此拉取请求，我确认您可以依照您的选择使用、修改、复制及重新分发此贡献。

根据需要与维护者沟通并进行任何请求的更改，并确保通过CI机器人触发的端到端测试通过。在我的情况下，我需要将cdk版本从2.133.0升级到2.145.0。更多详情请参阅我提交的PR，那里有相关细节。

最后，你可以要求合并这些更改。就这样吧！希望这份指南能帮助你了解如何为这个仓库做有效贡献，并鼓励你加入我们的贡献者行列。祝你在Amazon EKS Blueprints for CDK的贡献过程中愉快！

感谢你加入In Plain English社区！在你离开前：

• 记得给作者鼓掌👏并继续关注他们
• 关注我们：Twitter | LinkedIn | YouTube | Discord | Newsletter
• 访问我们的其他平台：CoFeed 和 Differ
• 更多内容请访问 PlainEnglish.io 网站