You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,7 @@
14
14
#### Mandatory Checklist
15
15
**PRs will only be reviewed after checklist is complete**
16
16
17
+
-[ ] Review the [generative AI contribution guidelines](https://github.com/aws/aws-sam-cli/blob/develop/CONTRIBUTING.md#ai-usage)
17
18
-[ ] Add input/output [type hints](https://docs.python.org/3/library/typing.html) to new functions/methods
18
19
-[ ] 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))
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11Lines changed: 11 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,17 @@ documentation, we greatly value feedback and contributions from our community.
8
8
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
9
9
information to effectively respond to your bug report or contribution.
10
10
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
+
11
22
## Development Guide
12
23
13
24
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