Skip to content

Commit 4b80854

Browse files
authored
Update sweep.yaml
1 parent 5ba7657 commit 4b80854

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

sweep.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
rules:
66
- "All new business logic should have corresponding unit tests."
77
- "Refactor large functions to be more modular."
8-
- "Add docstrings to all functions and file headers."
8+
- "Add javadoc to all functions except one-liners."
9+
- "Update the README.md file whenever a new feature is added. Make sure to include a description of the feature and any new commands."
910

1011
# This is the branch that Sweep will develop from and make pull requests to. Most people use 'main' or 'master' but some users also use 'dev' or 'staging'.
1112
branch: 'main'
@@ -18,7 +19,7 @@ gha_enabled: True
1819
# Example:
1920
#
2021
# description: sweepai/sweep is a python project. The main api endpoints are in sweepai/api.py. Write code that adheres to PEP8.
21-
description: ''
22+
description: 'AWS Lambda function written on Quarkus that responds to http requests, stores data in DynamoDB, reads recrets from AWS Systems Manager'
2223

2324
# This sets whether to create pull requests as drafts. If this is set to True, then all pull requests will be created as drafts and GitHub Actions will not be triggered.
2425
draft: False

0 commit comments

Comments
 (0)