Configure Sweep
🎉 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.yamlfile 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! 🧹
PR Summary
-
Introduction of Sweep Issue Template A new file was added to help create "Sweep" issues more efficiently. With the inclusion of specific fields such as name, title, description, and labels, this template will streamline the issue creation process.
-
Integration with Sweep AI A second file was included to configure the Sweep AI tool. This is a highly useful change because the Sweep AI assists in regularly checking rules, managing individual project aspects (branch names, descriptions), controlling draft PR settings, and barring changes to blocked directories. Furthermore, it offers direct access to necessary documentation.
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.