Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
217 changes: 217 additions & 0 deletions CREATE_PR_INSTRUCTIONS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,217 @@
# How to Create the Pull Request

## 🚀 Quick Start

The branch `feature/xlm-info-tooltip` has been pushed to your repository. Now you need to create a Pull Request on GitHub.

## 📝 Step-by-Step Instructions

### Option 1: Using GitHub Web Interface (Recommended)

1. **Navigate to GitHub**
- Go to: https://github.com/pitah23/FuTuRe
- You should see a yellow banner saying "feature/xlm-info-tooltip had recent pushes"
- Click the green "Compare & pull request" button

2. **Or use the direct link**
- Go to: https://github.com/pitah23/FuTuRe/pull/new/feature/xlm-info-tooltip
- This will open the PR creation page directly

3. **Fill in PR Details**
- **Title**: `feat: Add XLM info tooltip for new users`
- **Description**: Copy the content from `PR_DESCRIPTION.md` file
- **Base branch**: Ensure it's set to `main` (or the main branch of the upstream repo)
- **Compare branch**: Should be `feature/xlm-info-tooltip`

4. **Add Labels** (if available)
- `enhancement`
- `frontend`
- `accessibility`
- `ux-improvement`

5. **Request Reviewers**
- Add team members who should review the code
- Typically: frontend developers, UX designers, accessibility experts

6. **Create the PR**
- Click "Create pull request"
- The PR is now ready for review!

### Option 2: Using GitHub CLI (if installed)

```bash
gh pr create \
--title "feat: Add XLM info tooltip for new users" \
--body-file PR_DESCRIPTION.md \
--base main \
--head feature/xlm-info-tooltip
```

## 📋 PR Description Template

If you need to manually copy the PR description, here's the content:

```markdown
[Copy the entire content from PR_DESCRIPTION.md]
```

## ✅ Pre-PR Checklist

Before creating the PR, verify:

- [x] Branch pushed to remote: `feature/xlm-info-tooltip`
- [x] All files committed
- [x] Tests written and passing
- [x] Documentation complete
- [x] No merge conflicts with main
- [x] Code follows project standards
- [x] Accessibility tested
- [x] Mobile responsive tested

## 🔍 What Happens Next?

### 1. CI/CD Pipeline
The automated tests will run:
- Unit tests
- Integration tests
- Linting checks
- Build verification
- Coverage reports

### 2. Code Review
Reviewers will check:
- Code quality and standards
- Test coverage
- Accessibility compliance
- Mobile responsiveness
- Documentation completeness
- No breaking changes

### 3. Feedback & Iteration
- Address any review comments
- Make requested changes
- Push updates to the same branch
- PR will automatically update

### 4. Approval & Merge
Once approved:
- Squash and merge (recommended)
- Or merge commit
- Delete the feature branch after merge

## 🧪 Testing the PR

Reviewers can test by:

```bash
# Checkout the PR branch
git fetch origin
git checkout feature/xlm-info-tooltip

# Install dependencies (if needed)
npm install

# Run tests
npm test

# Start development server
npm run dev

# Run specific tests
npm test -- XLMInfoIcon
```

## 📸 Adding Screenshots

To make the PR more visual, consider adding screenshots:

1. **Balance Display**
- Screenshot showing XLM with info icon
- Screenshot of tooltip open

2. **Payment Form**
- Screenshot of helper text with icon
- Screenshot of tooltip in context

3. **Confirmation Dialog**
- Screenshot showing icons in summary

4. **Mobile View**
- Screenshot on mobile device
- Screenshot of touch interaction

To add screenshots to PR:
1. Take screenshots
2. Drag and drop into PR description
3. GitHub will upload and embed them

## 🔗 Useful Links

- **Repository**: https://github.com/pitah23/FuTuRe
- **Create PR**: https://github.com/pitah23/FuTuRe/pull/new/feature/xlm-info-tooltip
- **Branch**: https://github.com/pitah23/FuTuRe/tree/feature/xlm-info-tooltip
- **Documentation**: `frontend/docs/XLM_INFO_TOOLTIP.md`

## 💡 Tips for a Successful PR

1. **Clear Title**: Use conventional commit format
2. **Detailed Description**: Explain what, why, and how
3. **Screenshots**: Visual proof of changes
4. **Tests**: Show comprehensive coverage
5. **Documentation**: Link to relevant docs
6. **Small PRs**: This PR is focused on one feature ✅
7. **Self-Review**: Review your own code first
8. **Responsive**: Address feedback promptly

## 🐛 Troubleshooting

### PR Creation Issues

**Problem**: Can't see "Compare & pull request" button
- **Solution**: Use the direct link or navigate to Pull Requests tab and click "New pull request"

**Problem**: Wrong base branch selected
- **Solution**: Change the base branch dropdown to `main` or the correct upstream branch

**Problem**: Merge conflicts
- **Solution**:
```bash
git checkout main
git pull origin main
git checkout feature/xlm-info-tooltip
git merge main
# Resolve conflicts
git push origin feature/xlm-info-tooltip
```

### CI/CD Failures

**Problem**: Tests failing in CI
- **Solution**: Run tests locally first: `npm test`

**Problem**: Build failing
- **Solution**: Run build locally: `npm run build`

**Problem**: Linting errors
- **Solution**: Fix linting issues and push again

## 📞 Need Help?

If you encounter issues:
1. Check GitHub documentation
2. Review project contribution guidelines
3. Ask team members for assistance
4. Check CI/CD logs for specific errors

## 🎉 Success!

Once the PR is created:
- ✅ Monitor CI/CD pipeline
- ✅ Respond to review comments
- ✅ Make requested changes
- ✅ Celebrate when merged! 🎊

---

**Ready to create your PR?** Go to:
https://github.com/pitah23/FuTuRe/pull/new/feature/xlm-info-tooltip
Loading
Loading