Skip to content

Commit a1169de

Browse files
Configure Sweep (#233)
* Create sweep.yaml * Create sweep template * Update sweep.yaml --------- Co-authored-by: sweep-ai[bot] <128439645+sweep-ai[bot]@users.noreply.github.com> Co-authored-by: Yuriy Tkach <yuriytkach@gmail.com>
1 parent a55fb42 commit a1169de

File tree

2 files changed

+51
-0
lines changed

2 files changed

+51
-0
lines changed
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: Sweep Issue
2+
title: 'Sweep: '
3+
description: For small bugs, features, refactors, and tests to be handled by Sweep, an AI-powered junior developer.
4+
labels: sweep
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Details
10+
description: Tell Sweep where and what to edit and provide enough context for a new developer to the codebase
11+
placeholder: |
12+
Unit Tests: Write unit tests for <FILE>. Test each function in the file. Make sure to test edge cases.
13+
Bugs: The bug might be in <FILE>. Here are the logs: ...
14+
Features: the new endpoint should use the ... class from <FILE> because it contains ... logic.
15+
Refactors: We are migrating this function to ... version because ...

sweep.yaml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Sweep AI turns bugs & feature requests into code changes (https://sweep.dev)
2+
# For details on our config file, check out our docs at https://docs.sweep.dev/usage/config
3+
4+
# This setting contains a list of rules that Sweep will check for. If any of these rules are broken in a new commit, Sweep will create an pull request to fix the broken rule.
5+
rules:
6+
- "All new business logic should have corresponding unit tests."
7+
- "Refactor large functions to be more modular."
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."
10+
11+
# 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'.
12+
branch: 'main'
13+
14+
# By default Sweep will read the logs and outputs from your existing Github Actions. To disable this, set this to false.
15+
gha_enabled: True
16+
17+
# This is the description of your project. It will be used by sweep when creating PRs. You can tell Sweep what's unique about your project, what frameworks you use, or anything else you want.
18+
#
19+
# Example:
20+
#
21+
# description: sweepai/sweep is a python project. The main api endpoints are in sweepai/api.py. Write code that adheres to PEP8.
22+
description: 'AWS Lambda function written on Quarkus that responds to http requests, stores data in DynamoDB, reads recrets from AWS Systems Manager'
23+
24+
# 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.
25+
draft: False
26+
27+
# This is a list of directories that Sweep will not be able to edit.
28+
blocked_dirs: []
29+
30+
# This is a list of documentation links that Sweep will use to help it understand your code. You can add links to documentation for any packages you use here.
31+
#
32+
# Example:
33+
#
34+
# docs:
35+
# - PyGitHub: ["https://pygithub.readthedocs.io/en/latest/", "We use pygithub to interact with the GitHub API"]
36+
docs: []

0 commit comments

Comments
 (0)