From 0bef70ffb62558004fe1f21c287b1d38e0b663e3 Mon Sep 17 00:00:00 2001 From: Reed Hamilton Date: Wed, 22 Oct 2025 14:42:29 -0700 Subject: [PATCH] docs: update contributing guide to include ai usage --- .github/PULL_REQUEST_TEMPLATE.md | 8 +++++++- CONTRIBUTING.md | 10 ++++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ab40d21d7..b43bdacda 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,12 @@ *Issue #, if available:* -*Description of changes:* +### Description of changes + +### Description of how you validated changes + +### Checklist + +- [ ] Review the [generative AI contribution guidelines](https://github.com/aws/aws-lambda-builders/blob/develop/CONTRIBUTING.md#ai-usage) By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7366f727c..8cb825bea 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,6 +19,16 @@ reported the issue. Please try to include as much information as you can. Detail * Any modifications you've made relevant to the bug * Anything unusual about your environment or deployment +## AI Usage + +While using generative AI is allowed when contributing to this project, please keep the following points in mind: + +* Review all code yourself before you submit it. +* Understand all the code you have submitted in order to answer any questions the maintainers could have when reviewing your PR. +* Avoid being overly verbose in code and testing - extra code can be hard to review. + * For example, avoid writing unit tests that duplicate existing ones, or test libraries that you're using. +* Keep PR descriptions, comments, and follow ups concise. +* Ensure AI-generated code meets the same quality standards as human-written code. ## Contributing via Pull Requests Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that: