Enhance GitHub OAuth configuration instructions#223
Conversation
Expanded the GitHub OAuth configuration section with detailed steps for creating an OAuth app, copying the Client ID, and adding it to the project.
WalkthroughThe README's "Configuration" section was renamed to "🔑 Configuration (GitHub OAuth)" and replaced the prior concise guidance with a detailed 4-step GitHub OAuth setup guide (Create OAuth App, copy Client ID, add to project via local.properties, sync & run) and an expanded Notes section clarifying credential usage. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 374-377: The README's "### ❗ Important Notes" section contains an
inconsistent Client Secret message: update the bullet "- Never share your
**Client Secret** publicly." to match the earlier statement that the Client
Secret is "❗ NOT required for this project" by either removing the warning or
rewording it to: "This project uses OAuth Device Code flow and does not require
a Client Secret; if you use a Client Secret in other contexts, never share it
publicly." Edit the "### ❗ Important Notes" section and the related Client
Secret sentence so both convey the same guidance and eliminate developer
confusion.
🧹 Nitpick comments (1)
README.md (1)
348-358: Consider clarifying the Homepage URL field.The placeholder
https://github.com/username/repo_namein the table might leave developers uncertain about what to enter. Consider adding a brief note that this can be any valid URL (e.g., "your fork's URL or any valid URL you control").📝 Suggested clarification
| Field | Value | | ------------------------------ | ------------------------------------------- | | **Application name** | Anything you like (e.g. *GitHub Store Dev*) | -| **Homepage URL** | `https://github.com/username/repo_name` | +| **Homepage URL** | `https://github.com/username/repo_name` (or any valid URL) | | **Authorization callback URL** | `githubstore://callback` |
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Expanded the GitHub OAuth configuration section with detailed steps for creating an OAuth app, copying the Client ID, and adding it to the project.
Summary by CodeRabbit