Skip to content

BRANCH_AND_PR_GUIDE.md

Latest commit

 

History

History
233 lines (161 loc) · 5.49 KB

BRANCH_AND_PR_GUIDE.md

File metadata and controls

233 lines (161 loc) · 5.49 KB
Raw

Branch and Pull Request Guide

Current Status ✅

Your Material Design Breadcrumbs implementation is now properly on a feature branch!

Branch Information

  • Branch Name: feature/material-design-breadcrumbs
  • Base Branch: main
  • Commit: 9ee9343 - "feat: implement Material Design Breadcrumbs component"
  • Files Changed: 9 files, 1539 insertions(+), 31 deletions(-)
  • Tests: 37/37 passing ✅

What Was Done

  1. ✅ Stashed all changes from main branch
  2. ✅ Created new feature branch feature/material-design-breadcrumbs
  3. ✅ Applied changes to the feature branch
  4. ✅ Committed with descriptive conventional commit message
  5. ✅ Verified all tests pass on the new branch

Next Steps

1. Push the Feature Branch to Remote

git push -u origin feature/material-design-breadcrumbs

This will:

  • Push your feature branch to the remote repository
  • Set up tracking between local and remote branch

2. Create a Pull Request

After pushing, create a PR with the following details:

PR Title

feat: Implement Material Design Breadcrumbs Component

PR Description Template

## Description

Implements a Material Design breadcrumb navigation component to replace inline breadcrumb implementations throughout the project.

## Changes

- ✅ New Material Design 3 Breadcrumbs component with full accessibility support
- ✅ Comprehensive test suite (27 tests, 100% passing)
- ✅ Complete documentation and interactive demo page
- ✅ Replaced inline breadcrumbs in InteractiveCharts and PerformanceDashboard
- ✅ Added central UI components export file

## Features

- Material Design 3 styling with proper spacing and elevation
- Full accessibility (WCAG 2.1 Level AA compliant)
- Semantic HTML with ARIA labels and keyboard navigation
- Dark mode support
- Responsive design
- TypeScript support with full type definitions
- Custom icons, separators, and collapsed breadcrumbs
- Animated variant with Framer Motion

## Testing

- **Breadcrumbs Component**: 27/27 tests passing ✅
- **InteractiveCharts Integration**: 10/10 tests passing ✅
- **Total**: 37/37 tests passing ✅

## Documentation

- Component documentation: `src/components/ui/Breadcrumbs.md`
- Demo page: `/breadcrumbs-demo`
- Implementation summary: `BREADCRUMBS_IMPLEMENTATION_SUMMARY.md`

## Screenshots

<!-- Add screenshots of the breadcrumbs in action -->

- [ ] Basic breadcrumbs
- [ ] Breadcrumbs with icons
- [ ] Collapsed breadcrumbs
- [ ] Dark mode
- [ ] Demo page

## Checklist

- [x] Code follows project coding standards
- [x] All tests pass
- [x] No regression in existing functionality
- [x] Documentation is complete
- [x] Accessibility guidelines followed (WCAG 2.1 Level AA)
- [x] Performance impact is minimal
- [ ] Code review requested
- [ ] QA testing completed

## Related Issues

Closes #[issue-number] - Material Design Breadcrumbs Implementation

## Breaking Changes

None - This is a new component with backward-compatible integrations.

## Migration Guide

See `BREADCRUMBS_IMPLEMENTATION_SUMMARY.md` for migration examples from inline breadcrumbs to the new component.

3. Request Code Review

Tag relevant team members for review:

  • Frontend developers
  • Accessibility specialist (if available)
  • UI/UX designer (to verify Material Design compliance)

4. Address Review Comments

If reviewers request changes:

# Make the requested changes
git add <changed-files>
git commit -m "fix: address review comments - <description>"
git push

5. Merge the PR

Once approved, merge using your team's preferred strategy:

  • Squash and merge (recommended for feature branches)
  • Merge commit (preserves full history)
  • Rebase and merge (linear history)

6. Clean Up

After merging:

# Switch back to main
git checkout main

# Pull the latest changes
git pull origin main

# Delete the local feature branch
git branch -d feature/material-design-breadcrumbs

# Delete the remote feature branch (if not auto-deleted)
git push origin --delete feature/material-design-breadcrumbs

Additional Commands

View Commit Details

git show 9ee9343

View Changed Files

git diff main..feature/material-design-breadcrumbs --stat

Run Tests Before Pushing

npm test -- src/components/ui/__tests__/Breadcrumbs.test.tsx src/components/dashboard/__tests__/InteractiveCharts.test.tsx

Check Branch Status

git status
git log --oneline -5

GitHub CLI (Optional)

If you have GitHub CLI installed, you can create the PR directly:

gh pr create \
  --title "feat: Implement Material Design Breadcrumbs Component" \
  --body-file BREADCRUMBS_IMPLEMENTATION_SUMMARY.md \
  --base main \
  --head feature/material-design-breadcrumbs

Troubleshooting

If you need to make more changes before pushing:

# Make your changes
git add <files>
git commit -m "feat: additional improvements"
# Or amend the previous commit
git commit --amend --no-edit

If you accidentally committed to main:

# Don't worry, we already fixed this! But for future reference:
git reset --soft HEAD~1  # Undo commit, keep changes
git stash
git checkout -b feature/new-branch
git stash pop
git add <files>
git commit -m "your message"

Summary

✅ Your work is now properly organized on a feature branch ✅ All tests are passing ✅ Ready to push and create a PR ✅ No changes were lost in the process

Great job catching this! Following proper Git workflow is important for team collaboration and code review.