Skip to content

Commit 3a6a092

Browse files
committed
Enhance README with improved usage instructions, error handling details, and user experience features
1 parent a9a6e47 commit 3a6a092

File tree

1 file changed

+100
-29
lines changed

1 file changed

+100
-29
lines changed

README.md

Lines changed: 100 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,12 @@ A GitHub CLI extension that allows you to quickly react to pull request comments
1111
- General PR comments
1212
- Inline code review comments
1313
- Review summary comments
14-
- 🚀 Dynamic PR number support
14+
- 🚀 **User-friendly numbered selection** - No more copying long IDs!
15+
- 🌈 **Beautiful colored output** with emojis and visual indicators
1516
- 🔍 Automatic comment type detection
16-
- ✅ Comprehensive error handling
17-
- 📋 Lists all available comments with IDs
17+
- ✅ Comprehensive error handling and validation
18+
- � Smart progress indicators
19+
- 💡 Helpful tips and guidance
1820

1921
## Install
2022

@@ -37,29 +39,75 @@ gh react 23
3739

3840
### What happens:
3941

40-
1. **Fetches all comments** from the specified PR
41-
2. **Lists comments** with their IDs and authors
42-
3. **Prompts for comment ID** to react to
43-
4. **Asks for reaction type** from available options
44-
5. **Sends the reaction** via GitHub API
42+
1. **🔍 Validates PR** - Checks if the PR exists and you have access
43+
2. **📊 Fetches all content** - Gets PR description, comments, and reviews
44+
3. **📋 Shows numbered list** - Displays all content with easy-to-use numbers
45+
4. **🔢 Simple selection** - Just type a number (1, 2, 3...) instead of long IDs
46+
5. **😊 Pick reaction** - Choose from visual emoji options
47+
6. **🚀 Instant feedback** - Confirms success with direct PR link
4548

4649
### Example Output
4750

4851
```bash
4952
$ gh react 23
50-
Fetching comments for PR #23...
51-
Checking if PR #23 exists...
52-
Fetching comments...
53-
PR_BODY|23|manishraj27: fix: update homepage URL in package.json
54-
ISSUE|3045853431|manishraj27: test
55-
56-
Enter comment ID to react to: 3045853431
57-
Pick a reaction: (+1, -1, laugh, heart, hooray, rocket, eyes)
58-
Reaction: +1
59-
Sending reaction...
60-
Done! 👍
53+
💬 GitHub PR Reaction Tool
54+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
55+
👀 Fetching comments for PR #23...
56+
👀 Repository: manishraj27/mern-project-cli
57+
✅ PR #23 found!
58+
59+
👀 Gathering all comments and content...
60+
✅ Found 3 items to react to!
61+
62+
📋 Available Content:
63+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
64+
[1] 💬 Comment by @manishraj27
65+
└─ test...
66+
67+
[2] 📄 PR Description by @manishraj27
68+
└─ fix: update homepage URL in package.json...
69+
70+
[3] 🔍 Code Review by @someuser
71+
└─ This looks good but consider...
72+
73+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
74+
75+
😊 Choose what to react to:
76+
🔢 Enter number (1-3): 1
77+
78+
👀 Selected: ISSUE by @manishraj27
79+
80+
😊 Available reactions:
81+
👍 +1 👎 -1 😄 laugh
82+
❤️ heart 🎉 hooray 🚀 rocket 👀 eyes
83+
84+
🎯 Pick a reaction: +1
85+
86+
👀 Sending +1 reaction to comment...
87+
88+
🚀 Reaction added successfully! 🎉
89+
90+
🔗 View PR: https://github.com/manishraj27/mern-project-cli/pull/23
91+
👍 Added thumbs up!
6192
```
6293

94+
## User Experience
95+
96+
### 🎯 **Simple Number Selection**
97+
No more copying long comment IDs! Just type `1`, `2`, or `3` to select what you want to react to.
98+
99+
### 🌈 **Beautiful Visual Interface**
100+
- Color-coded content types (PR descriptions, comments, reviews)
101+
- Progress indicators and status messages
102+
- Emoji reactions and visual feedback
103+
- Clean, organized layout with separators
104+
105+
### 💡 **Smart Error Handling**
106+
- Validates PR existence before fetching
107+
- Checks if you have proper access permissions
108+
- Provides helpful tips when things go wrong
109+
- Shows exact error details when needed
110+
63111
## Available Reactions
64112

65113
| Reaction | Description |
@@ -74,24 +122,47 @@ Done! 👍
74122

75123
## Comment Types Supported
76124

77-
- **PR_BODY**: The main PR description/body
78-
- **ISSUE**: General comments on the PR conversation
79-
- **REVIEW**: Inline comments on specific lines of code
80-
- **REVIEW_SUMMARY**: Comments submitted with code reviews
125+
| Type | Icon | Description |
126+
|------|------|-------------|
127+
| **PR_BODY** | 📄 | The main PR description/body |
128+
| **ISSUE** | 💬 | General comments on the PR conversation |
129+
| **REVIEW** | 🔍 | Inline comments on specific lines of code |
130+
| **REVIEW_SUMMARY** | 📝 | Comments submitted with code reviews |
81131

82132
## Requirements
83133

84134
- [GitHub CLI](https://cli.github.com/) installed and authenticated
85135
- Access to the repository containing the PR
86-
- Bash shell environment
136+
- Bash shell environment (Linux, macOS, WSL, Git Bash)
87137

88138
## Error Handling
89139

90-
The extension handles various scenarios:
91-
- Invalid or non-existent PR numbers
92-
- PRs with no comments
93-
- Authentication issues
94-
- Network connectivity problems
140+
The extension gracefully handles various scenarios:
141+
- ❌ Invalid or non-existent PR numbers
142+
- 🔒 PRs with no comments or restricted access
143+
- 🔐 Authentication and permission issues
144+
- 🌐 Network connectivity problems
145+
- 🔢 Invalid number selections or reaction types
146+
- 💡 Provides helpful tips and suggestions for resolution
147+
148+
## Quick Start
149+
150+
1. **Install the extension**:
151+
```bash
152+
gh extension install manishraj27/gh-react
153+
```
154+
155+
2. **Navigate to your repository**:
156+
```bash
157+
cd your-repo
158+
```
159+
160+
3. **React to a PR**:
161+
```bash
162+
gh react 23
163+
```
164+
165+
4. **Follow the prompts** - just type numbers and pick reactions!
95166

96167
## Contributing
97168

0 commit comments

Comments
 (0)