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! 🧹

[stackblitz]

Run & review this pull request in StackBlitz Codeflow.

[restack-app]

No applications have been configured for previews targeting branch: main. To do so go to restack console and configure your applications for previews.

[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 and tests for Sweep to handle.

The sweep.yaml file includes settings for:

• Rules that Sweep should enforce in new commits.
• The branch to which Sweep will make pull requests.
• Whether Sweep should use GitHub Actions logs.
• A project description for context in PRs.
• Whether PRs should be created as drafts.
• Directories that Sweep should not edit.
• Documentation links to help Sweep understand the project's code.

Suggestion

The PR seems well-structured and the sweep.yaml file is comprehensive. However, it would be beneficial to provide an example project description in the description field of the sweep.yaml file to guide users on how to effectively describe their project for Sweep's understanding.

Additionally, it might be helpful to include comments in the blocked_dirs and docs sections to explain how users can specify directories to block and documentation links, respectively, as these sections are currently empty and may not be self-explanatory for all users.

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

Current plan usage: 21.11%

Have feedback or need help?
Discord
Documentation
[email protected]

[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.