gen-pr 2.13.0 → 2.14.0

package/README.md

@@ -5,20 +5,44 @@
 
 # gen-pr
 
-A CLI and GitHub Action that automatically generate pull requests using AI (specifically, Large Language Models or LLMs).
+A CLI and GitHub Action that automatically generates pull requests using AI (specifically, Large Language Models or LLMs) from GitHub issues and pull requests.
 
-This tool embodies the ultimate "Vibe Coding" experience, where humans can focus solely on writing issues while AI handles all the implementation details. Our vision is to create a workflow where developers only need to describe what they want, and the AI takes care of translating those requirements into working code.
+This tool delivers the ultimate "Vibe Coding" experience, allowing humans to focus solely on writing issues while AI handles all implementation details. Our vision is to create a workflow where developers only need to describe what they want, and the AI translates those requirements into working code.
 
 ## Features
 
-- **Planning Capability**: Uses LLM to analyze source code and develop implementation strategies before making any changes
-- **Multiple AI Coding Tools**: Supports various coding tools including:
+- **Planning Capability**: Uses LLMs to analyze source code and develop implementation strategies before making any changes.
+- **Multiple AI Coding Tools**: Supports various coding tools, including:
   - [Aider](https://aider.chat/): An interactive AI pair programming tool
   - [Codex CLI](https://github.com/openai/codex): OpenAI's coding agent
   - [Claude Code](https://github.com/anthropics/claude-code): Anthropic's agentic coding tool
   - [Gemini CLI](https://github.com/google-gemini/gemini-cli): Google's AI coding assistant
 - **Flexible Integration**: Works as both a CLI tool and a GitHub Action
 
+## Our Use Cases
+
+Currently, we use `gen-pr` to create scaffolding pull requests. We have five different `gen-pr` workflows to generate PRs with various combinations of LLMs and coding tools.
+We review the pull requests, select the best one, and then continue to write code on the PR manually. This approach has successfully reduced the amount of manually written code.
+Below is an analysis report generated by [calc-ai-contrib](https://github.com/WillBooster/calc-ai-contrib) for June 2025, during the development of [Exercode](https://exercode.willbooster.com/).
+`AI` indicates the amount of code written fully automatically by `gen-pr`. We are very satisfied with the results and consider the AI contribution ratio a key metric for measuring our productivity.
+
+```
+╔══════════════════════════════════════════════════╗
+║           CONTRIBUTION ANALYSIS REPORT           ║
+╠══════════════════════════════════════════════════╣
+║ Date: 2025-06-01 to 2025-06-30 (PRs: 91)         ║
+║ Total Edits: 9,925 (+6,729 / -3,196)             ║
+╠══════════════════════════════════════════════════╣
+║ AI vs Human: [█████░░░░░░░░░░░░░░░░░] 24% / 76%  ║
+║ Contributors: 1 AI, 6 Human                      ║
+╚══════════════════════════════════════════════════╝
+
+📊 DETAILED BREAKDOWN
+────────────────────────────────────────
+🤖 AI   : [████░░░░░░░░░░░░]  24% |    2,365 Edits (+1,685 / -680)
+👥 Human: [████████████░░░░]  76% |    7,560 Edits (+5,044 / -2,516)
+```
+
 ## Requirements
 
 - For development:
@@ -113,6 +137,17 @@ Codex:
 npx --yes gen-pr@latest --issue-number 103 --coding-tool codex
 ```
 
+### Config File
+
+You can create a YAML configuration file named `gen-pr.config.yml` or `gen-pr.config.yaml` in the root of your repository to set default values for options. This config file works for both CLI usage and GitHub Actions. Command-line flags (CLI) or workflow inputs (GitHub Actions) will override values in this file. For example:
+
+```yaml
+repomix-extra-args: "--compress --remove-empty-lines --include 'src/**/*.ts'"
+aider-extra-args: "--model gemini/gemini-2.5-pro --edit-format diff-fenced --no-gitignore"
+coding-tool: claude-code
+test-command: "yarn check-for-ai"
+```
+
 ### Supported Model Format
 
 The tool requires **model names defined on [llmlite](https://docs.litellm.ai/docs/providers)** in the format `provider/model-name`: