Skip to content

Commit 73bdb22

Browse files
committed
docs: format contributing table, add inactivity policy, and clarify README workflow description
1 parent 8c3fef2 commit 73bdb22

2 files changed

Lines changed: 10 additions & 7 deletions

File tree

CONTRIBUTING.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -162,21 +162,23 @@ CommitPulse uses a custom, lightweight **GitHub Actions** automation system to m
162162

163163
Our automation runs entirely through issue comments. Here is how you interact with it:
164164

165-
| Command | Who Can Use It? | What It Does |
166-
|---------|-----------------|--------------|
167-
| `/claim` | **Anyone** | Self-assigns the issue to you. |
168-
| `/addlabel <label1> <label2>` | **Anyone** | Adds labels to the issue (e.g. `/addlabel frontend bug`). |
169-
| `/unassign @username` | **Maintainers Only** | Removes the assignee from an issue. |
170-
| `/assign @username` | **Maintainers Only** | Manually assigns someone to an issue. |
165+
| Command | Who Can Use It? | What It Does |
166+
| ----------------------------- | -------------------- | --------------------------------------------------------- |
167+
| `/claim` | **Anyone** | Self-assigns the issue to you. |
168+
| `/addlabel <label1> <label2>` | **Anyone** | Adds labels to the issue (e.g. `/addlabel frontend bug`). |
169+
| `/unassign @username` | **Maintainers Only** | Removes the assignee from an issue. |
170+
| `/assign @username` | **Maintainers Only** | Manually assigns someone to an issue. |
171171

172172
### ⏳ The Inactivity Policy (Assignment Expiry)
173173

174174
To keep the project moving, assignments are not permanent.
175+
175176
- **The 3-Day Rule:** If an issue has an assignee but sees **no activity for 3 days**, our automated background job will remove the assignment.
176177
- **What counts as activity?** Posting a comment, opening a linked PR, or a maintainer adding a label.
177178
- **Why?** It frees up stale issues so other active contributors can pick them up. If your issue expires, you can always `/claim` it again if it's still available!
178179

179180
### 💡 GSSoC Contributor Flow
181+
180182
1. Find an unassigned open issue you want to work on.
181183
2. Comment `/claim` to lock it in.
182184
3. Need labels? Comment `/addlabel good-first-issue` (labels must already exist in the repo).

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,9 +236,10 @@ Set the `GITHUB_PAT` environment variable in your Vercel project settings, and y
236236

237237
## 🤖 Automated Contributor Workflow
238238

239-
CommitPulse features a fully custom, GitHub Actions-powered **Issue Management System** designed for large open-source events like GSSoC.
239+
CommitPulse features a fully custom, GitHub Actions-powered **Issue Management System** designed for large open-source events like GSSoC.
240240

241241
We built an anti-hoarding, self-service automation layer right into the repository:
242+
242243
- **Self-Claiming:** Contributors can grab issues instantly by commenting `/claim`.
243244
- **Fair Play:** A strict one-active-issue-per-contributor rule prevents issue hoarding.
244245
- **Stale Expiry:** A scheduled chron job automatically unassigns inactive contributors after 3 days.

0 commit comments

Comments
 (0)