|
4 | 4 | <!-- Organization Logo --> |
5 | 5 | <div align="center" style="display: flex; align-items: center; justify-content: center; gap: 16px;"> |
6 | 6 | <img alt="AOSSIE" src="public/aossie-logo.svg" width="175"> |
7 | | - <img alt="Gitcord" src="public/gitcord-logo.svg" width="175" /> |
| 7 | + <img alt="Gitcord" src="public/gitcord.svg" width="175" /> |
8 | 8 | </div> |
9 | 9 |
|
10 | 10 | |
@@ -58,6 +58,7 @@ Gitcord is a local, offline‑first automation engine that reads GitHub activity |
58 | 58 | ## 💻 Tech Stack |
59 | 59 |
|
60 | 60 | ### Backend |
| 61 | + |
61 | 62 | - Python 3.11+ |
62 | 63 | - SQLite (local state) |
63 | 64 | - Pydantic + PyYAML |
@@ -87,6 +88,7 @@ Read -> Plan -> Report -> Apply |
87 | 88 | ``` |
88 | 89 |
|
89 | 90 | Core boundaries: |
| 91 | + |
90 | 92 | - Readers are read‑only (GitHub/Discord ingestion). |
91 | 93 | - Planners are pure, deterministic logic. |
92 | 94 | - Writers are thin executors gated by `MutationPolicy`. |
@@ -129,14 +131,17 @@ Before installing Gitcord, you need: |
129 | 131 | ### Quick Setup Overview |
130 | 132 |
|
131 | 133 | **1. Create GitHub Token** ([Detailed Guide](INSTALLATION.md#step-1-create-github-token-pat)) |
| 134 | + |
132 | 135 | - Go to GitHub → Settings → Developer Settings → Fine-grained tokens |
133 | 136 | - Permissions: Contents (Read & Write), Issues (Read & Write), Pull requests (Read & Write) |
134 | 137 |
|
135 | 138 | **2. Create Discord Bot** ([Detailed Guide](INSTALLATION.md#step-2-create-discord-bot)) |
| 139 | + |
136 | 140 | - Go to [Discord Developer Portal](https://discord.com/developers/applications) |
137 | 141 | - Create Application → Add Bot → Enable **Server Members Intent** |
138 | 142 |
|
139 | 143 | **3. Invite Bot to Server** ([Detailed Guide](INSTALLATION.md#step-3-invite-bot-to-discord-server)) |
| 144 | + |
140 | 145 | - OAuth2 → URL Generator |
141 | 146 | - Scopes: `bot`, `applications.commands` |
142 | 147 | - Permissions: `Manage Roles`, `View Channels`, `Send Messages`, `Embed Links`, `Read Message History` |
@@ -197,24 +202,27 @@ Wait 30 seconds for commands to sync. |
197 | 202 | 2. **Live role updates:** To have the bot actually add/remove roles in Discord, set in your config: |
198 | 203 | - `runtime.mode: "active"` |
199 | 204 | - `discord.permissions.write: true` |
200 | | - Then run `run-once` again. Ensure the bot’s role in the server is **above** any roles it should assign (Server Settings → Roles). See [Testing in Discord](docs/TESTING_DISCORD.md) for details. |
| 205 | + Then run `run-once` again. Ensure the bot’s role in the server is **above** any roles it should assign (Server Settings → Roles). See [Testing in Discord](docs/TESTING_DISCORD.md) for details. |
201 | 206 |
|
202 | 207 | --- |
203 | 208 |
|
204 | 209 | ## 🤖 Discord Bot Commands |
205 | 210 |
|
206 | 211 | ### Identity Linking |
| 212 | + |
207 | 213 | - `/link` - Link your Discord account to GitHub (creates verification code) |
208 | 214 | - `/verify-link` - Verify your GitHub link after adding code to bio/gist |
209 | 215 | - `/verify` - Check your verification status |
210 | 216 | - `/status` - Show verification state, activity window, and roles |
211 | 217 | - `/unlink` - Unlink your GitHub identity |
212 | 218 |
|
213 | 219 | ### Contribution & Metrics |
| 220 | + |
214 | 221 | - `/summary` - Show your contribution metrics (7 and 30 days) |
215 | 222 | - `/pr-info` - Show PR context preview (repository, reviews, CI status) |
216 | 223 |
|
217 | 224 | ### Issue Management |
| 225 | + |
218 | 226 | - `/request-issue` - Request to be assigned to a GitHub issue |
219 | 227 | - `/assign-issue` - Assign issue to Discord user (mentor-only) |
220 | 228 | - `/issue-requests` - Review pending issue requests (mentor-only) |
|
0 commit comments