Skip to content

Commit e927546

Browse files
authored
docs: update contributing guide to include ai usage (#3834)
1 parent b0231f5 commit e927546

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
### Checklist
88

9+
- [ ] Review the [generative AI contribution guidelines](https://github.com/aws/serverless-application-model/blob/develop/CONTRIBUTING.md#ai-usage)
910
- [ ] Adheres to the [development guidelines](https://github.com/aws/serverless-application-model/blob/develop/DEVELOPMENT_GUIDE.md#development-guidelines)
1011
- [ ] Add/update [transform tests](https://github.com/aws/serverless-application-model/blob/develop/DEVELOPMENT_GUIDE.md#unit-testing-with-multiple-python-versions)
1112
- [ ] Using correct values

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,17 @@ transparent and open process for evolving AWS SAM.
77

88
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.
99

10+
## AI Usage
11+
12+
While using generative AI is allowed when contributing to this project, please keep the following points in mind:
13+
14+
* Review all code yourself before you submit it.
15+
* Understand all the code you have submitted in order to answer any questions the maintainers could have when reviewing your PR.
16+
* Avoid being overly verbose in code and testing - extra code can be hard to review.
17+
* For example, avoid writing unit tests that duplicate existing ones, or test libraries that you're using.
18+
* Keep PR descriptions, comments, and follow ups concise.
19+
* Ensure AI-generated code meets the same quality standards as human-written code.
20+
1021
## Integrating AWS SAM into your tool
1122

1223
We encourage you to modify SAM to integrate it with other frameworks and deployment providers from the community for building serverless applications. If you're building a new tool that will use AWS SAM, let us know how we can help!

0 commit comments

Comments
 (0)