sweep.yaml

# Sweep AI turns bugs & feature requests into code changes (https://sweep.dev)
# For details on our config file, check out our docs at https://docs.sweep.dev/usage/config

# 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.
rules:
  - "All new business logic should have corresponding unit tests."
  - "Add jsdoc to all functions and file headers."

# 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'.
branch: 'main'

# By default Sweep will read the logs and outputs from your existing Github Actions. To disable this, set this to false.
gha_enabled: True

# 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.
#
# Example:
#
# description: sweepai/sweep is a python project. The main api endpoints are in sweepai/api.py. Write code that adheres to PEP8.
description: |
  ## Directory Structure
  The project is divided into three main directories as mentioned in the [README](./README.md) file:
  - Frontend: `./frontend`
  - Backend: `./backend`
  - Deployment: `./deployment`
  ## Backend Tech Stack
  - **Node.js**: The runtime environment for executing JavaScript server-side.
  - **Express**: A web framework for Node.js.
  - **Sequelize**: A promise-based Node.js ORM for SQL databases.
  - **PostgreSQL**: The database used for storing application data.
  - **Docker**: Used for containerizing the backend service for quick setup and testing.
  ## Frontend Tech Stack
  - **React**: The library used for building the user interface.
  - **Axios**: Promise-based HTTP client for making API calls.
  - **@mui/material**: Material-UI library for React components.
  - **Docker**: Used for containerizing the frontend service for quick setup and testing.

# 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.
draft: True

# This is a list of directories that Sweep will not be able to edit.
blocked_dirs: []

# 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.
#
# Example:
#
# docs:
#   - PyGitHub: ["https://pygithub.readthedocs.io/en/latest/", "We use pygithub to interact with the GitHub API"]
docs: []