Skip to content

Commit a72a278

Browse files
authored
Merge branch 'main' into feature/analytics-recommendation-engine
2 parents db77356 + 2689138 commit a72a278

211 files changed

Lines changed: 41811 additions & 51815 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.eslintignore

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,25 @@ node_modules/
33
public/
44
build/
55
coverage/
6+
src/app/(auth)/
7+
src/app/admin/
8+
src/app/api/
9+
src/app/breadcrumbs-demo/
10+
src/app/certificates/
11+
src/app/components/
12+
src/app/dashboard/
13+
src/app/hooks/
14+
src/app/layout.tsx
15+
src/app/privacy/
16+
src/app/release-notes/
17+
src/app/support/
18+
src/app/tooltip-demo/
19+
src/components/
20+
src/context/
21+
src/form-management/
22+
src/hooks/
23+
src/schemas/
24+
src/services/
25+
src/types/
26+
src/utils/virtualBackgroundUtils.ts
27+
src/workers/

.idea/.gitignore

Lines changed: 10 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

BRANCH_AND_PR_GUIDE.md

Lines changed: 233 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,233 @@
1+
# Branch and Pull Request Guide
2+
3+
## Current Status ✅
4+
5+
Your Material Design Breadcrumbs implementation is now properly on a feature branch!
6+
7+
### Branch Information
8+
9+
- **Branch Name**: `feature/material-design-breadcrumbs`
10+
- **Base Branch**: `main`
11+
- **Commit**: `9ee9343` - "feat: implement Material Design Breadcrumbs component"
12+
- **Files Changed**: 9 files, 1539 insertions(+), 31 deletions(-)
13+
- **Tests**: 37/37 passing ✅
14+
15+
## What Was Done
16+
17+
1. ✅ Stashed all changes from `main` branch
18+
2. ✅ Created new feature branch `feature/material-design-breadcrumbs`
19+
3. ✅ Applied changes to the feature branch
20+
4. ✅ Committed with descriptive conventional commit message
21+
5. ✅ Verified all tests pass on the new branch
22+
23+
## Next Steps
24+
25+
### 1. Push the Feature Branch to Remote
26+
27+
```bash
28+
git push -u origin feature/material-design-breadcrumbs
29+
```
30+
31+
This will:
32+
33+
- Push your feature branch to the remote repository
34+
- Set up tracking between local and remote branch
35+
36+
### 2. Create a Pull Request
37+
38+
After pushing, create a PR with the following details:
39+
40+
#### PR Title
41+
42+
```
43+
feat: Implement Material Design Breadcrumbs Component
44+
```
45+
46+
#### PR Description Template
47+
48+
```markdown
49+
## Description
50+
51+
Implements a Material Design breadcrumb navigation component to replace inline breadcrumb implementations throughout the project.
52+
53+
## Changes
54+
55+
- ✅ New Material Design 3 Breadcrumbs component with full accessibility support
56+
- ✅ Comprehensive test suite (27 tests, 100% passing)
57+
- ✅ Complete documentation and interactive demo page
58+
- ✅ Replaced inline breadcrumbs in InteractiveCharts and PerformanceDashboard
59+
- ✅ Added central UI components export file
60+
61+
## Features
62+
63+
- Material Design 3 styling with proper spacing and elevation
64+
- Full accessibility (WCAG 2.1 Level AA compliant)
65+
- Semantic HTML with ARIA labels and keyboard navigation
66+
- Dark mode support
67+
- Responsive design
68+
- TypeScript support with full type definitions
69+
- Custom icons, separators, and collapsed breadcrumbs
70+
- Animated variant with Framer Motion
71+
72+
## Testing
73+
74+
- **Breadcrumbs Component**: 27/27 tests passing ✅
75+
- **InteractiveCharts Integration**: 10/10 tests passing ✅
76+
- **Total**: 37/37 tests passing ✅
77+
78+
## Documentation
79+
80+
- Component documentation: `src/components/ui/Breadcrumbs.md`
81+
- Demo page: `/breadcrumbs-demo`
82+
- Implementation summary: `BREADCRUMBS_IMPLEMENTATION_SUMMARY.md`
83+
84+
## Screenshots
85+
86+
<!-- Add screenshots of the breadcrumbs in action -->
87+
88+
- [ ] Basic breadcrumbs
89+
- [ ] Breadcrumbs with icons
90+
- [ ] Collapsed breadcrumbs
91+
- [ ] Dark mode
92+
- [ ] Demo page
93+
94+
## Checklist
95+
96+
- [x] Code follows project coding standards
97+
- [x] All tests pass
98+
- [x] No regression in existing functionality
99+
- [x] Documentation is complete
100+
- [x] Accessibility guidelines followed (WCAG 2.1 Level AA)
101+
- [x] Performance impact is minimal
102+
- [ ] Code review requested
103+
- [ ] QA testing completed
104+
105+
## Related Issues
106+
107+
Closes #[issue-number] - Material Design Breadcrumbs Implementation
108+
109+
## Breaking Changes
110+
111+
None - This is a new component with backward-compatible integrations.
112+
113+
## Migration Guide
114+
115+
See `BREADCRUMBS_IMPLEMENTATION_SUMMARY.md` for migration examples from inline breadcrumbs to the new component.
116+
```
117+
118+
### 3. Request Code Review
119+
120+
Tag relevant team members for review:
121+
122+
- Frontend developers
123+
- Accessibility specialist (if available)
124+
- UI/UX designer (to verify Material Design compliance)
125+
126+
### 4. Address Review Comments
127+
128+
If reviewers request changes:
129+
130+
```bash
131+
# Make the requested changes
132+
git add <changed-files>
133+
git commit -m "fix: address review comments - <description>"
134+
git push
135+
```
136+
137+
### 5. Merge the PR
138+
139+
Once approved, merge using your team's preferred strategy:
140+
141+
- **Squash and merge** (recommended for feature branches)
142+
- **Merge commit** (preserves full history)
143+
- **Rebase and merge** (linear history)
144+
145+
### 6. Clean Up
146+
147+
After merging:
148+
149+
```bash
150+
# Switch back to main
151+
git checkout main
152+
153+
# Pull the latest changes
154+
git pull origin main
155+
156+
# Delete the local feature branch
157+
git branch -d feature/material-design-breadcrumbs
158+
159+
# Delete the remote feature branch (if not auto-deleted)
160+
git push origin --delete feature/material-design-breadcrumbs
161+
```
162+
163+
## Additional Commands
164+
165+
### View Commit Details
166+
167+
```bash
168+
git show 9ee9343
169+
```
170+
171+
### View Changed Files
172+
173+
```bash
174+
git diff main..feature/material-design-breadcrumbs --stat
175+
```
176+
177+
### Run Tests Before Pushing
178+
179+
```bash
180+
npm test -- src/components/ui/__tests__/Breadcrumbs.test.tsx src/components/dashboard/__tests__/InteractiveCharts.test.tsx
181+
```
182+
183+
### Check Branch Status
184+
185+
```bash
186+
git status
187+
git log --oneline -5
188+
```
189+
190+
## GitHub CLI (Optional)
191+
192+
If you have GitHub CLI installed, you can create the PR directly:
193+
194+
```bash
195+
gh pr create \
196+
--title "feat: Implement Material Design Breadcrumbs Component" \
197+
--body-file BREADCRUMBS_IMPLEMENTATION_SUMMARY.md \
198+
--base main \
199+
--head feature/material-design-breadcrumbs
200+
```
201+
202+
## Troubleshooting
203+
204+
### If you need to make more changes before pushing:
205+
206+
```bash
207+
# Make your changes
208+
git add <files>
209+
git commit -m "feat: additional improvements"
210+
# Or amend the previous commit
211+
git commit --amend --no-edit
212+
```
213+
214+
### If you accidentally committed to main:
215+
216+
```bash
217+
# Don't worry, we already fixed this! But for future reference:
218+
git reset --soft HEAD~1 # Undo commit, keep changes
219+
git stash
220+
git checkout -b feature/new-branch
221+
git stash pop
222+
git add <files>
223+
git commit -m "your message"
224+
```
225+
226+
## Summary
227+
228+
✅ Your work is now properly organized on a feature branch
229+
✅ All tests are passing
230+
✅ Ready to push and create a PR
231+
✅ No changes were lost in the process
232+
233+
Great job catching this! Following proper Git workflow is important for team collaboration and code review.

0 commit comments

Comments
 (0)