Skip to content

Commit b64a915

Browse files
authored
docs: update contributing guide to include ai usage (#791)
1 parent 2481b86 commit b64a915

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
*Issue #, if available:*
22

3-
*Description of changes:*
3+
### Description of changes
4+
5+
### Description of how you validated changes
6+
7+
### Checklist
8+
9+
- [ ] Review the [generative AI contribution guidelines](https://github.com/aws/aws-lambda-builders/blob/develop/CONTRIBUTING.md#ai-usage)
410

511

612
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,16 @@ reported the issue. Please try to include as much information as you can. Detail
1919
* Any modifications you've made relevant to the bug
2020
* Anything unusual about your environment or deployment
2121

22+
## AI Usage
23+
24+
While using generative AI is allowed when contributing to this project, please keep the following points in mind:
25+
26+
* Review all code yourself before you submit it.
27+
* Understand all the code you have submitted in order to answer any questions the maintainers could have when reviewing your PR.
28+
* Avoid being overly verbose in code and testing - extra code can be hard to review.
29+
* For example, avoid writing unit tests that duplicate existing ones, or test libraries that you're using.
30+
* Keep PR descriptions, comments, and follow ups concise.
31+
* Ensure AI-generated code meets the same quality standards as human-written code.
2232

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

0 commit comments

Comments
 (0)