From cfc91a8289c6243fe0e3d608ad3909d56eefa6cf Mon Sep 17 00:00:00 2001 From: sweep-support Date: Fri, 16 Aug 2024 16:18:49 -0700 Subject: [PATCH 1/2] Update README.md --- README.md | 114 ++---------------------------------------------------- 1 file changed, 4 insertions(+), 110 deletions(-) diff --git a/README.md b/README.md index 4f80ca0ff6..beb0a0f97e 100644 --- a/README.md +++ b/README.md @@ -1,118 +1,12 @@

-

- Github Issues ⟶  Pull Requests! -

-

- - Install Sweep Github App - - - - - - Docker Pulls - - - Docs - - - - - - PyPI version - - - Self Host Sweep Docker Image - - - Python Unit Tests - -

- ---- - -Sweep is an AI junior developer that turns bugs and feature requests into code changes. Sweep automatically handles devex improvements like adding typehints/improving test coverage. :robot: - -[Install Sweep](https://github.com/apps/sweep-ai) and open a Github Issue like: `Sweep: Add typehints to src/utils/github_utils.py` and Sweep will: -1. Search through your codebase to find the dependencies of github_utils.py -2. Modify the code to add typehints -3. **Run and debug your code to write a Pull Request** ⚡ - -### Features -* Turns issues directly into pull requests (without an IDE) -* Addresses developer replies & comments on its PRs -* Understands your codebase using the dependency graph, text, and vector search. -* Runs your unit tests and autoformatters to validate generated code. -* Stack small fixes into your PR by applying [Sweep Rules](https://docs.sweep.dev/usage/config#tips-for-writing-rules) - -[![Sweep Youtube Tutorial](docs/public/assets/youtube_thumbnail.png)](https://www.youtube.com/watch?v=GVEkDZmWw8E) - - -> [!NOTE] -> ### What makes Sweep Different -> We've been addressing code modification using LLMs for a while. We found and are fixing a lot of issues. -> - **Modifying Code** - LLMs like GPT4 don't have a great way to automatically modify code. We heavily experiment on different ways to modify code so you don't have to. We've spent a really long time working on this - check out https://docs.sweep.dev/blogs/gpt-4-modification! -> - **Planning Code Changes** - Retrieval-Augmented-Generation isn't enough. We wrote a code chunker that's used fairly heavily, and we're constantly improving this: https://docs.sweep.dev/blogs/chunking-improvements -> - Sweep runs your **Github Actions**, catching bugs and making sure each line of new code has been properly validated! -> - **Sweep** uses it's sandbox to format your code, and uses [Rules](https://docs.sweep.dev/usage/config#tips-for-writing-rules) to perform other changes like adding typehints, or any other small chores! - - -## Getting Started - -### GitHub App -Install Sweep by adding the [**Sweep GitHub App**](https://github.com/apps/sweep-ai) to your desired repositories. - -* For more details, visit our [installation page](https://docs.sweep.dev/getting-started). - -* Note: Sweep only considers issues with the "Sweep:" title on creation and not on update. If you want Sweep to pick up an existing issue, you can add the "Sweep" label to the issue. - -* We focus on Python but support all languages GPT-4 can write. This includes JS/TS, Rust, Go, Java, C# and C++. --- -## Story +Sweep is an AI junior developer that turns bugs and feature requests into code changes. :robot: -We used to work in large, messy repositories, and we noticed how complex the code could get without regular refactors and unit tests. We realized that AI could handle these chores for us, so we built Sweep! +Hi everyone! -Unlike existing AI solutions, Sweep can solve entire tickets and can be parallelized + asynchronous: developers can spin up 10 tickets and Sweep will address them all at once. - -## Pricing -Every user receives unlimited GPT-3.5 tickets and 5 GPT-4 tickets per month. For professionals who want to try unlimited GPT-4 tickets and priority support, you can get a one week free trial of [Sweep Pro](https://buy.stripe.com/00g5npeT71H2gzCfZ8). - -For more GPT-4 tickets visit our payment portal! - -You can get enterprise support by [contacting us](https://form.typeform.com/to/wliuvyWE). - ---- - -> [!WARNING] -> ### Limitations of Sweep -> * **Large-scale refactors**: > 10 files or > 400 lines of code changes - * e.g. Refactor the entire codebase from TensorFlow to PyTorch - * If this is a use case you're looking forward to, let us know! -> * **Editing images** and other non-text assets - * e.g. Create favicons for our landing page - * We can, however, read images. ---- - -## Contributing - -Contributions are welcome and greatly appreciated! To get set up, see [Development](https://github.com/sweepai/sweep#development). For detailed guidelines on how to contribute, please see the [CONTRIBUTING.md](CONTRIBUTING.md) file. - - -

- Contributors -

-

- Thank you for your contribution! -

-

- - - -

-

- and, of course, Sweep! -

+Thank you for all of the support so far. +We've moved to a new frontend-based app that is available [via request here](https://form.typeform.com/to/wliuvyWE). From 065580da97893b5fd7c32375546b5f5e49014a99 Mon Sep 17 00:00:00 2001 From: Tor137951 Date: Thu, 14 Nov 2024 21:57:58 +0700 Subject: [PATCH 2/2] Create devcontainer.json --- .devcontainer/devcontainer.json | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .devcontainer/devcontainer.json diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 0000000000..ad93c14a0f --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,5 @@ +{ + "image": "mcr.microsoft.com/devcontainers/universal:2", + "features": { + } +}