Configure Sweep

[sweep-ai-deprecated]

🎉 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-deprecated]

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 assistant designed to help with code changes on GitHub. The sweep.yaml file allows users to customize how Sweep operates within their project by specifying rules for code commits, the target branch for PRs, integration with GitHub Actions, project description, draft PR settings, and directories that are off-limits to the AI. Additionally, a new issue template for Sweep-related tasks is added to streamline the process of reporting bugs, requesting features, or suggesting refactors and tests.

Suggestion

Ensure that the rules defined in the sweep.yaml file are aligned with the project's coding standards and practices. Review and adjust the description field to provide specific details about the project, which will help Sweep generate more accurate PRs. Consider whether you want PRs to be created as drafts by default, as this affects the triggering of GitHub Actions. Lastly, review the blocked_dirs list to ensure that Sweep does not modify directories that should remain untouched.

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

Current plan usage: 78.39%

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