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. The PR also includes a new issue template for Sweep-related issues.

Key features and implications of the PR:

• Sweep becomes customizable, allowing project maintainers to set rules, specify the development branch, enable/disable GitHub Actions integration, provide a project description, and decide whether PRs should be drafts.
• The sweep.yaml file includes settings for rules that, if broken, will prompt Sweep to create a PR to address the issue.
• Users can specify directories that Sweep should not edit and provide documentation links to help Sweep understand the project's code.
• A sandbox environment is configured to validate code changes, ensuring code quality.

Suggestion

• Ensure that the rules defined in the sweep.yaml file are clear, concise, and aligned with the project's coding standards and practices.
• Review the blocked_dirs list to confirm that all sensitive directories are included, preventing unwanted changes by the AI.
• Populate the description field with relevant information about the project to assist Sweep in making more accurate code changes.
• Verify that the sandbox environment commands are compatible with the project's setup and will not cause any unintended side effects.

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

Current plan usage: 9.48%

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