Updated root docs

This commit is contained in:
Jon Michael Aanes 2025-04-13 18:38:08 +02:00
parent 1c4e13b7d0
commit 15f6077b99

View File

@ -1,9 +1,27 @@
"""# Aider Gitea """# Aider Gitea.
Work in progress code automation tool. A code automation tool that integrates [Gitea](https://about.gitea.com/) with [Aider](https://aider.chat/) to automatically solve issues.
Use [Aider](https://aider.chat/) by creating issues. The program will then ## Overview
automatically invoke Aider and create a pull request for the issue.
Aider Gitea monitors your Gitea repository for issues with the 'aider' label.
When such an issue is found, it:
1. Creates a new branch.
2. Invokes Aider to solve the issue using a Large-Language Model.
3. Runs tests and code quality checks.
4. Creates a pull request with the solution.
## Example Usage
### Command Line
```bash
# Run with default settings
python -m aider_gitea
# Specify custom repository and owner
python -m aider_gitea --owner myorg --repo myproject
```
""" """
import argparse import argparse
@ -178,7 +196,7 @@ def solve_issue_in_repository(
# Auto-fix standard code quality stuff # Auto-fix standard code quality stuff
run_cmd(['bash', '-c', RUFF_FORMAT_AND_AUTO_FIX], tmpdirname, check=False) run_cmd(['bash', '-c', RUFF_FORMAT_AND_AUTO_FIX], tmpdirname, check=False)
run_cmd(['git', 'add', '.'], tmpdirname) run_cmd(['git', 'add', '.'], tmpdirname)
run_cmd(['git', 'commit', '-m', 'Ruff'], tmpdirname) run_cmd(['git', 'commit', '-m', 'Ruff'], tmpdirname, check=False)
# Push changes # Push changes
return push_changes( return push_changes(