Configure Sweep

[sweep-ai]

🎉 Thank you for installing Sweep! We're thrilled to announce the latest update for Sweep, your AI junior developer on GitHub. This PR creates a sweep.yaml config file, allowing you to personalize Sweep's performance according to your project requirements.

What's new?

• Sweep is now configurable.
• To configure Sweep, simply edit the sweep.yaml file in the root of your repository.
• If you need help, check out the Sweep Default Config or Join Our Discord for help.

If you would like me to stop creating this PR, go to issues and say "Sweep: create an empty sweep.yaml file".
Thank you for using Sweep! 🧹

[sweep-ai]

Apply Sweep Rules to your PR?

• Apply: All new business logic should have corresponding unit tests.
• Apply: Refactor large functions to be more modular.
• Apply: Add docstrings to all functions and file headers.

[codeautopilot]

PR summary

The Pull Request introduces a configuration file (sweep.yaml) for Sweep, an AI-powered junior developer tool on GitHub. The sweep.yaml file allows users to customize how Sweep operates within their project. The PR also adds a GitHub issue template (sweep-template.yml) to streamline the process of reporting bugs, requesting features, or suggesting refactors that Sweep can handle.

The sweep.yaml file includes settings for:

• Rules that Sweep will enforce through pull requests.
• The branch that Sweep will target for pull requests.
• GitHub Actions integration.
• A project description for context in PRs.
• Whether PRs should be created as drafts.
• Directories that Sweep should not edit.

The issue template is designed to capture detailed instructions for Sweep, providing context and specifics about the codebase to guide the AI's contributions.

Suggestion

The PR seems well-structured and doesn't require immediate changes. However, it would be beneficial to ensure that the description field in the sweep.yaml file is filled out with relevant information about the project to maximize Sweep's effectiveness. Additionally, the team should review the rules and blocked_dirs to ensure they align with the project's standards and structure.

Disclaimer: This comment was entirely generated using AI. Be aware that the information provided may be incorrect.

Current plan usage: 17.58%

Have feedback or need help?
Discord
Documentation
support@codeautopilot.com