https://github.com/qkitzero/ant-pr
🐜 Github Actions for small, beautiful pull requests
https://github.com/qkitzero/ant-pr
code-review developer-tools github-actions pull-requests
Last synced: 3 months ago
JSON representation
🐜 Github Actions for small, beautiful pull requests
- Host: GitHub
- URL: https://github.com/qkitzero/ant-pr
- Owner: qkitzero
- Created: 2025-07-26T06:30:24.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2026-03-15T07:37:58.000Z (3 months ago)
- Last Synced: 2026-03-15T19:25:50.951Z (3 months ago)
- Topics: code-review, developer-tools, github-actions, pull-requests
- Language: Python
- Homepage:
- Size: 128 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# 🐜 Ant PR: "Small Pull Requests are Beautiful"
[](https://github.com/qkitzero/ant-pr/releases)
**A GitHub Action that champions the philosophy of small, incremental changes by keeping your pull requests tiny and manageable.**
Just like a colony of ants working together with small, consistent efforts to build something great, this action helps your team maintain a healthy and efficient development workflow.
---
## ✨ Why Small Pull Requests?
Smaller pull requests are:
- **✅ Easier & Faster to Review:** Less code means quicker, more thorough reviews.
- **🐛 Easier to Debug:** Pinpoint issues with surgical precision.
- **🚀 Deployed Faster:** Small changes merge smoothly into the main branch.
- **🧘 Less Stressful:** Reduce the mental load for both authors and reviewers.
Ant PR helps you enforce this best practice automatically.
## 🚀 Getting Started
Integrate Ant PR into your workflow in seconds.
### 1. Create the Workflow
Create a workflow file (e.g., `.github/workflows/ant-pr.yml`) with the following content. This workflow ensures that the action has the necessary information to compare file changes.
```yaml:ant-pr.yml
name: Ant PR
on:
pull_request:
types: [opened, synchronize, reopened]
branches-ignore:
- "main"
permissions:
pull-requests: write
jobs:
ant-pr:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: qkitzero/ant-pr@v1.5.1
with:
config-path: ".ant-pr.yml"
github-token: ${{ secrets.GITHUB_TOKEN }}
```
### 2. Configure Limits
Create a `.ant-pr.yml` file in your repository to define limits for line changes and the total number of changed files.
If this file is not present, the action will still run, but no limits will be enforced.
```yaml:.ant-pr.yml
limits:
files: 15 # Limit the total number of changed files in a PR.
lines: # Define line change limits for different parts of your codebase.
"": 100 # Root directory
"frontend/": 200
"backend/": 200
"docs/": 300
```
### 3. Ignoring Files
You can also ignore files that you don't want to be checked by adding an `ignore` section to your `.ant-pr.yml` file. This is useful for ignoring auto-generated files like `package-lock.json`.
```yaml:.ant-pr.yml
ignore:
- "package-lock.json"
- "gen/*"
```
That's it! Ant PR will now check new pull requests and add a comment if they exceed the defined limits.