gitpadi 2.0.1 โ†’ 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,270 +1,102 @@
1
- <p align="center">
2
- <h1 align="center">๐Ÿค– GitPadi</h1>
3
- <p align="center"><strong>Your AI-powered GitHub management agent.</strong></p>
4
- <p align="center">
5
- Auto-score contributors, review PRs, manage issues & repos โ€” from your terminal or as a GitHub Action.
6
- </p>
7
- <p align="center">
8
- <a href="#-use-the-cli">CLI</a> โ€ข
9
- <a href="#-use-as-github-action">GitHub Action</a> โ€ข
10
- <a href="#-scoring-algorithm">Scoring Algorithm</a>
11
- </p>
12
- </p>
1
+ # ๐Ÿค– GitPadi
13
2
 
14
- ---
15
-
16
- ## โšก Two Ways to Use GitPadi
3
+ GitPadi is a GitHub management CLI and Action built to automate the repetitive parts of maintaining open-source projects.
17
4
 
18
- | Method | Best For | Setup |
19
- |--------|----------|-------|
20
- | **CLI** (`npx gitpadi`) | Hands-on management from your terminal | One command |
21
- | **GitHub Action** | Automated scoring & reviews on every event | Copy one workflow file |
5
+ Whether you're a maintainer managing hundreds of issues or a contributor making your first PR, GitPadi turns multi-step GitHub workflows into single commands.
22
6
 
23
7
  ---
24
8
 
25
- ## ๐Ÿ–ฅ๏ธ Use the CLI
9
+ ## ๐Ÿš€ For Contributors
26
10
 
27
- **No installation needed.** Run directly with `npx`:
11
+ Stop worrying about forking, upstream remotes, and branch naming. GitPadi handles the plumbing so you can focus on the code.
28
12
 
13
+ ### Start a new contribution
29
14
  ```bash
30
- export GITHUB_TOKEN=ghp_your_token
31
- export GITHUB_OWNER=your-org
32
- export GITHUB_REPO=your-repo
33
-
34
- npx gitpadi
35
- ```
36
-
37
- That launches the **interactive terminal**:
38
-
39
- ```
40
- โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
41
- โ”‚ ๐Ÿค– GitPadi v2.0 โ”‚
42
- โ”‚ Your GitHub Management Companion โ”‚
43
- โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
44
-
45
- ? What would you like to do?
46
- ๐Ÿ“‹ Manage Issues
47
- ๐Ÿ”€ Manage Pull Requests
48
- ๐Ÿ“ฆ Manage Repositories
49
- ๐Ÿ† Score Contributors
50
- ๐Ÿš€ Create Release
51
- โš™๏ธ Switch Repo
52
- ๐Ÿ‘‹ Exit
15
+ npx gitpadi start <issue-url>
53
16
  ```
17
+ This single command:
18
+ 1. **Forks** the repository to your account.
19
+ 2. **Clones** it to your machine.
20
+ 3. Sets up the **upstream remote**.
21
+ 4. Creates a **fresh feature branch** linked to the issue.
54
22
 
55
- Or use **direct commands**:
56
-
23
+ ### Submit your work
57
24
  ```bash
58
- npx gitpadi issues list
59
- npx gitpadi prs merge 5 --method squash
60
- npx gitpadi contributors score octocat
61
- npx gitpadi repo create my-app --org MyOrg
25
+ npx gitpadi submit
62
26
  ```
27
+ When you're done, this command:
28
+ 1. **Stages** all your changes.
29
+ 2. Creates a **commit** with a clean message.
30
+ 3. **Pushes** to your fork.
31
+ 4. Opens a **Pull Request** on the original repo, auto-linked to the issue.
32
+
33
+ ---
63
34
 
64
- ### All CLI Commands
35
+ ## ๐Ÿ› ๏ธ For Maintainers
65
36
 
66
- <details>
67
- <summary><b>๐Ÿ“‹ Issues</b></summary>
37
+ Manage your community and project health directly from your terminal.
68
38
 
39
+ ### ๐Ÿ“‹ Bulk Issue Creation
40
+ Create dozens of issues in seconds from a simple Markdown or JSON file.
69
41
  ```bash
70
- npx gitpadi issues list # List open issues
71
- npx gitpadi issues create -t "Bug fix" -l bug # Create issue
72
- npx gitpadi issues bulk -f issues.json # Bulk create from JSON
73
- npx gitpadi issues close 42 # Close issue
74
- npx gitpadi issues reopen 42 # Reopen issue
75
- npx gitpadi issues delete 42 # Close & lock
76
- npx gitpadi issues assign 42 alice bob # Assign users
77
- npx gitpadi issues assign-best 42 # ๐Ÿ† Auto-assign top scorer
78
- npx gitpadi issues search "login bug" # Search issues
79
- npx gitpadi issues label 42 bug priority-high # Add labels
42
+ npx gitpadi issues bulk -f roadmap.md
80
43
  ```
81
- </details>
82
-
83
- <details>
84
- <summary><b>๐Ÿ”€ Pull Requests</b></summary>
44
+ *(Supports `## Heading` titles and `**Labels:**` tags).*
85
45
 
46
+ ### ๐Ÿ† Smart Contributor Scoring
47
+ Auto-score applicants based on their GitHub history, account age, and relevance to the issue.
86
48
  ```bash
87
- npx gitpadi prs list # List open PRs
88
- npx gitpadi prs merge 5 --method squash # Merge PR (squash/merge/rebase)
89
- npx gitpadi prs close 5 # Close PR
90
- npx gitpadi prs review 5 # Auto-review (size, tests, security)
91
- npx gitpadi prs approve 5 # Approve PR
92
- npx gitpadi prs diff 5 # Show changed files
49
+ npx gitpadi contributors score octocat
93
50
  ```
94
- </details>
95
-
96
- <details>
97
- <summary><b>๐Ÿ“ฆ Repositories</b></summary>
98
-
51
+ Or let GitPadi find the best applicant for an issue:
99
52
  ```bash
100
- npx gitpadi repo list --org MyOrg # List repos
101
- npx gitpadi repo create my-app --org MyOrg # Create repo
102
- npx gitpadi repo delete my-app --org MyOrg # Delete repo
103
- npx gitpadi repo clone my-app # Clone repo
104
- npx gitpadi repo info my-app # Show repo details
105
- npx gitpadi repo topics my-app rust blockchain # Set topics
53
+ npx gitpadi issues assign-best 42
106
54
  ```
107
- </details>
108
55
 
109
- <details>
110
- <summary><b>๐Ÿ† Contributors</b></summary>
56
+ ### ๐Ÿ”€ Advanced PR Management
57
+ - **Review PRs**: Get an automated review (size analysis, security checks, test coverage).
58
+ - **Fast Merge**: Squash and merge PRs directly from the CLI.
59
+ - **CI Status**: View GitHub Action logs for a PR without opening a browser.
111
60
 
112
- ```bash
113
- npx gitpadi contributors score octocat # Score a user (0-100)
114
- npx gitpadi contributors rank 42 # Rank all applicants for issue #42
115
- npx gitpadi contributors list # List repo contributors
116
- ```
117
- </details>
61
+ ---
118
62
 
119
- <details>
120
- <summary><b>๐Ÿš€ Releases</b></summary>
63
+ ## โšก Quick Start
64
+
65
+ No installation required. Just set your token and go:
121
66
 
122
67
  ```bash
123
- npx gitpadi release create v1.0.0 # Create release (auto-notes)
124
- npx gitpadi release create v1.0.0 --draft # Create as draft
125
- npx gitpadi release list # List releases
68
+ export GITHUB_TOKEN=ghp_your_token
69
+ npx gitpadi
126
70
  ```
127
- </details>
128
-
129
- ### Or install globally:
130
71
 
72
+ ### Direct Commands
131
73
  ```bash
132
- npm install -g gitpadi
133
- gitpadi issues list
74
+ npx gitpadi issues list --limit 100
75
+ npx gitpadi prs review 5
76
+ npx gitpadi release create v1.0.0
134
77
  ```
135
78
 
136
79
  ---
137
80
 
138
- ## ๐Ÿ”ง Use as GitHub Action
139
-
140
- Just add a workflow file โ€” no setup, no tokens to manage.
81
+ ## ๐Ÿ”ง Use as a GitHub Action
141
82
 
142
- ### ๐Ÿ† Auto-Score Contributors
83
+ GitPadi can run on every event in your repo. Just add a workflow file.
143
84
 
85
+ **Auto-Score Applicants:**
144
86
  ```yaml
145
- # .github/workflows/applicant-scorer.yml
146
- name: Score Applicants
147
- on:
148
- issue_comment:
149
- types: [created]
150
- permissions:
151
- contents: read
152
- issues: write
153
- pull-requests: read
154
- jobs:
155
- score:
156
- if: "!github.event.issue.pull_request"
157
- runs-on: ubuntu-latest
158
- steps:
159
- - uses: actions/checkout@v4
160
- - uses: Netwalls/contributor-agent@v2
161
- with:
162
- action: score-applicant
163
- notify-user: 'your-username' # โ† you get @mentioned
87
+ - uses: Netwalls/contributor-agent@v2
88
+ with:
89
+ action: score-applicant
164
90
  ```
165
91
 
166
- ### ๐Ÿ” Auto-Review PRs
167
-
92
+ **Auto-Review PRs:**
168
93
  ```yaml
169
- # .github/workflows/pr-review.yml
170
- name: PR Review
171
- on:
172
- pull_request:
173
- types: [opened, synchronize, reopened]
174
- permissions:
175
- contents: read
176
- pull-requests: write
177
- jobs:
178
- review:
179
- runs-on: ubuntu-latest
180
- steps:
181
- - uses: actions/checkout@v4
182
- - uses: Netwalls/contributor-agent@v2
183
- with:
184
- action: review-pr
185
- ```
186
-
187
- ### ๐Ÿ“‹ Bulk Create Issues
188
-
189
- ```yaml
190
- # .github/workflows/create-issues.yml
191
- name: Create Issues
192
- on:
193
- workflow_dispatch:
194
- inputs:
195
- issues-file:
196
- description: 'Path to issues JSON'
197
- default: 'issues.json'
198
- dry-run:
199
- description: 'Preview only'
200
- default: 'true'
201
- permissions:
202
- issues: write
203
- jobs:
204
- create:
205
- runs-on: ubuntu-latest
206
- steps:
207
- - uses: actions/checkout@v4
208
- - uses: Netwalls/contributor-agent@v2
209
- with:
210
- action: create-issues
211
- issues-file: ${{ github.event.inputs.issues-file }}
212
- dry-run: ${{ github.event.inputs.dry-run }}
213
- ```
214
-
215
- ---
216
-
217
- ## ๐Ÿ† Scoring Algorithm
218
-
219
- GitPadi scores contributors on **6 dimensions** (100 points total):
220
-
221
- | Category | Max | What It Measures |
222
- |----------|-----|-----------------|
223
- | ๐Ÿ”ง **Repo Experience** | **30** | Merged PRs, open PRs, issues in YOUR specific repo |
224
- | ๐Ÿ›๏ธ Account Maturity | 15 | Account age |
225
- | ๐ŸŒ GitHub Presence | 15 | Public repos, followers, profile README |
226
- | โšก Activity Level | 15 | Recent public GitHub activity |
227
- | ๐Ÿ“ Application Quality | 15 | Comment depth โ€” mentions approach, experience, timeline |
228
- | ๐Ÿ’ป Language Relevance | 10 | User's languages match issue label languages |
229
-
230
- ### Tiers
231
-
232
- | Tier | Score | Recommendation |
233
- |------|-------|---------------|
234
- | ๐Ÿ† **S** | 75+ | Strong โ€” assign immediately |
235
- | ๐ŸŸข **A** | 55-74 | Good โ€” assign with confidence |
236
- | ๐ŸŸก **B** | 40-54 | Decent โ€” review profile first |
237
- | ๐ŸŸ  **C** | 25-39 | Below average โ€” wait for better |
238
- | ๐Ÿ”ด **D** | 0-24 | Low โ€” manual review needed |
239
-
240
- ### Detected Application Phrases
241
-
242
- > *"I'd like to work on this"* ยท *"Can I take this?"* ยท *"Assign me"* ยท *"I'm interested"* ยท *"I want to contribute"* ยท *"Let me handle this"* ยท *"Picking this up"* ยท *"Claiming this"*
243
-
244
- ---
245
-
246
- ## โš™๏ธ Configuration
247
-
248
- ### Environment Variables
249
-
250
- | Variable | Required | Description |
251
- |----------|----------|-------------|
252
- | `GITHUB_TOKEN` | โœ… | GitHub PAT with `repo` scope |
253
- | `GITHUB_OWNER` | For CLI | Org or username |
254
- | `GITHUB_REPO` | For CLI | Repository name |
255
-
256
- ### CLI Flags
257
-
258
- ```bash
259
- npx gitpadi --owner MyOrg --repo my-project --token ghp_xxx issues list
94
+ - uses: Netwalls/contributor-agent@v2
95
+ with:
96
+ action: review-pr
260
97
  ```
261
98
 
262
99
  ---
263
100
 
264
101
  ## ๐Ÿ“„ License
265
-
266
- MIT โ€” Built by [Netwalls](https://github.com/Netwalls)
267
-
268
-
269
-
270
- i noticed that a users have more issues but it is just bring out the top 10 issues that are open how do we bring out more issues
102
+ MIT โ€” Built by [Netwalls](https://github.com/Netwalls)