Skip to content

Commit d856d3c

Browse files
reedham-awsvicheey
andauthored
docs: add section to contributing.md about ai usage (#8359)
* docs: add section to contributing.md about ai usage * docs: update pull request template --------- Co-authored-by: vicheey <181402101+vicheey@users.noreply.github.com>
1 parent 41fd19e commit d856d3c

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
@@ -14,6 +14,7 @@
1414
#### Mandatory Checklist
1515
**PRs will only be reviewed after checklist is complete**
1616

17+
- [ ] Review the [generative AI contribution guidelines](https://github.com/aws/aws-sam-cli/blob/develop/CONTRIBUTING.md#ai-usage)
1718
- [ ] Add input/output [type hints](https://docs.python.org/3/library/typing.html) to new functions/methods
1819
- [ ] Write design document if needed ([Do I need to write a design document?](https://github.com/aws/aws-sam-cli/blob/develop/DEVELOPMENT_GUIDE.md#design-document))
1920
- [ ] Write/update unit tests

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,17 @@ documentation, we greatly value feedback and contributions from our community.
88
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
99
information to effectively respond to your bug report or contribution.
1010

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

1324
Refer to the [Development Guide](DEVELOPMENT_GUIDE.md) for help with environment setup, running tests, submitting a PR, or anything that will make you more productive.

0 commit comments

Comments
 (0)