From 99ee31601edd337d6336b08108ff8348a125deeb Mon Sep 17 00:00:00 2001 From: Rahul Jain Date: Wed, 15 Oct 2025 21:22:53 +0530 Subject: [PATCH 1/3] chore: fix asset path again and refactor pull_request template --- .github/PULL_REQUEST_TEMPLATE.md | 192 ++++++++++++++++++++++++++----- src/components/layout/footer.tsx | 2 +- src/components/layout/header.tsx | 2 +- 3 files changed, 164 insertions(+), 32 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 96fac79e..0673abfb 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,42 +1,174 @@ -## What type of PR is this? (check all applicable) +# ๐Ÿ”„ Pull Request + +## ๐Ÿ“‹ **Type of Change** (check all applicable) + +- [ ] ๐Ÿ› **Bug Fix** - Fixes an issue without breaking existing functionality +- [ ] โœจ **Feature** - Adds new functionality +- [ ] โšก **Performance** - Improves performance without changing functionality +- [ ] โ™ป๏ธ **Refactor** - Code changes that neither fix bugs nor add features +- [ ] ๐Ÿ“š **Documentation** - Updates to documentation, comments, or README +- [ ] ๐ŸŽจ **Style** - Code style changes (formatting, missing semi-colons, etc.) +- [ ] ๐Ÿงช **Test** - Adding or updating tests +- [ ] ๐Ÿ—๏ธ **Build** - Changes to build system or dependencies +- [ ] ๐Ÿ‘ท **CI/CD** - Changes to CI/CD workflows +- [ ] ๐Ÿ”’ **Security** - Security improvements or vulnerability fixes +- [ ] โ™ฟ **Accessibility** - Improves accessibility compliance +- [ ] ๐Ÿ“ฑ **Mobile** - Mobile-specific improvements +- [ ] ๐ŸŒ **i18n** - Internationalization changes + +## ๐Ÿ“– **Description** + + + +### **What changed?** + + + +### **Why was this change made?** + + + +### **How does this change help users?** + + + +## ๐Ÿ”— **Related Issues** + + + +- Closes # +- Fixes # +- Related to # + +## ๐Ÿงช **Testing & Quality Assurance** + +### **Testing Done** (check all applicable) + +- [ ] โœ… **Manual testing** - Tested functionality manually +- [ ] ๐Ÿงช **Unit tests** - Added/updated unit tests +- [ ] ๐Ÿ”„ **Integration tests** - Tested with other components +- [ ] ๐Ÿ“ฑ **Mobile testing** - Tested on mobile devices +- [ ] โ™ฟ **Accessibility testing** - Tested with screen readers/keyboard nav +- [ ] ๐ŸŒ **Cross-browser testing** - Tested in multiple browsers +- [ ] ๐ŸŽจ **Visual testing** - Checked UI/UX in light/dark themes + +### **Test Instructions** + + + +1. +2. +3. + +### **Expected Behavior** + + + +## ๐Ÿ“ธ **Screenshots/Recordings** + + + +### **Before** + + + +### **After** + + + +## ๐Ÿ“‹ **Checklist** + +### **Code Quality** + +- [ ] ๐Ÿ” **TypeScript** - No TypeScript errors (`npm run type-check`) +- [ ] ๐Ÿงน **Linting** - No ESLint errors (`npm run lint`) +- [ ] ๐ŸŽจ **Formatting** - Code is properly formatted (`npm run format`) +- [ ] ๐Ÿ—๏ธ **Build** - Production build succeeds (`npm run build`) +- [ ] โšก **Performance** - No performance regressions introduced + +### **Accessibility** + +- [ ] โ™ฟ **WCAG Compliance** - Follows WCAG 2.1 AA guidelines +- [ ] โŒจ๏ธ **Keyboard Navigation** - All interactive elements are keyboard accessible +- [ ] ๐Ÿ” **Screen Reader** - Proper ARIA labels and semantic HTML +- [ ] ๐ŸŽจ **Color Contrast** - Meets contrast requirements +- [ ] ๐ŸŽฏ **Focus Management** - Visible focus indicators + +### **Mobile & Responsive** + +- [ ] ๐Ÿ“ฑ **Mobile Responsive** - Works on mobile devices (320px+) +- [ ] ๐Ÿ–ฅ๏ธ **Desktop** - Works on desktop (1024px+) +- [ ] ๐Ÿ“ **Tablet** - Works on tablet sizes (768px+) +- [ ] ๐Ÿ”„ **Orientation** - Works in portrait and landscape + +### **Browser Compatibility** + +- [ ] ๐ŸŒ **Chrome** - Latest version +- [ ] ๐ŸฆŠ **Firefox** - Latest version +- [ ] ๐Ÿงญ **Safari** - Latest version +- [ ] ๐Ÿ“ฑ **Mobile Safari** - iOS Safari +- [ ] ๐Ÿ“ฑ **Chrome Mobile** - Android Chrome + +### **Documentation** + +- [ ] ๐Ÿ“š **Code Comments** - Added helpful comments for complex logic +- [ ] ๐Ÿ“– **Documentation** - Updated relevant documentation +- [ ] ๐Ÿ“ **README** - Updated README if needed +- [ ] ๐Ÿ”„ **Changelog** - Will be auto-generated from conventional commits + +### **Security & Privacy** + +- [ ] ๐Ÿ”’ **No Secrets** - No API keys, passwords, or sensitive data exposed +- [ ] ๐Ÿ›ก๏ธ **Input Validation** - Proper validation for user inputs +- [ ] ๐Ÿ” **XSS Prevention** - Protected against XSS attacks +- [ ] ๐Ÿช **Privacy Compliant** - Follows GDPR/privacy requirements + +## ๐Ÿš€ **Deployment Notes** -- [ ] Refactor -- [ ] Feature -- [ ] Bug Fix -- [ ] Enhancement -- [ ] Documentation Update + -## Description +- [ ] **No breaking changes** - Backward compatible +- [ ] **Database changes** - N/A (static site) +- [ ] **Environment variables** - No new env vars needed +- [ ] **Third-party dependencies** - No new external dependencies -## Related Tickets & Documents +## ๐Ÿ“ **Additional Notes** -## QA Instructions, Screenshots, Recordings + -_Please replace this line with instructions on how to test your changes, as well -as any relevant images for UI changes._ +## ๐Ÿ‘€ **Reviewers** - + -- [ ] yes -- [ ] no, because they aren't needed -- [ ] no, because I need help --> +--- -## Added to documentation? +**By submitting this PR, I confirm that:** -- [ ] readme +- โœ… I have read and agree to the [Code of Conduct](https://github.com/rahuldkjain/github-profile-readme-generator/blob/master/CODE_OF_CONDUCT.md) +- โœ… I have followed the [Contributing Guidelines](https://github.com/rahuldkjain/github-profile-readme-generator/blob/master/CONTRIBUTING.md) +- โœ… I have used [Conventional Commits](https://github.com/rahuldkjain/github-profile-readme-generator/blob/master/COMMIT_CONVENTION.md) for my commit messages +- โœ… I have tested my changes thoroughly +- โœ… My code follows the project's coding standards diff --git a/src/components/layout/footer.tsx b/src/components/layout/footer.tsx index 21e94b7d..3caec194 100644 --- a/src/components/layout/footer.tsx +++ b/src/components/layout/footer.tsx @@ -2,7 +2,7 @@ import Link from 'next/link'; import Image from 'next/image'; // Import the logo as a static asset for GitHub Pages compatibility -import logoImage from '../../images/mdg.png'; +import logoImage from '@/images/mdg.png'; export function Footer() { return ( diff --git a/src/components/layout/header.tsx b/src/components/layout/header.tsx index 9c431790..0ad65126 100644 --- a/src/components/layout/header.tsx +++ b/src/components/layout/header.tsx @@ -8,7 +8,7 @@ import { AccessibilityMenu } from '@/components/ui/accessibility-menu'; import { GitHubStats } from '@/components/ui/github-stats'; // Import the logo as a static asset for GitHub Pages compatibility -import logoImage from '../../images/mdg.png'; +import logoImage from '@/images/mdg.png'; const navigation = [ { name: 'Generator', href: '/' }, From 2c3c5981f6220829ac90527a5baa07448e268257 Mon Sep 17 00:00:00 2001 From: Rahul Jain Date: Wed, 15 Oct 2025 21:25:57 +0530 Subject: [PATCH 2/3] chore: fix asset path again attempt #3 --- src/components/layout/footer.tsx | 4 ++-- src/components/layout/header.tsx | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/components/layout/footer.tsx b/src/components/layout/footer.tsx index 3caec194..94f4caf9 100644 --- a/src/components/layout/footer.tsx +++ b/src/components/layout/footer.tsx @@ -1,8 +1,8 @@ import Link from 'next/link'; import Image from 'next/image'; -// Import the logo as a static asset for GitHub Pages compatibility -import logoImage from '@/images/mdg.png'; +// Import logo from public directory for GitHub Pages compatibility +import logoImage from '../../../public/mdg.png'; export function Footer() { return ( diff --git a/src/components/layout/header.tsx b/src/components/layout/header.tsx index 0ad65126..f863762a 100644 --- a/src/components/layout/header.tsx +++ b/src/components/layout/header.tsx @@ -7,8 +7,8 @@ import { ThemeToggle } from '@/components/ui/theme-toggle'; import { AccessibilityMenu } from '@/components/ui/accessibility-menu'; import { GitHubStats } from '@/components/ui/github-stats'; -// Import the logo as a static asset for GitHub Pages compatibility -import logoImage from '@/images/mdg.png'; +// Import logo from public directory for GitHub Pages compatibility +import logoImage from '../../../public/mdg.png'; const navigation = [ { name: 'Generator', href: '/' }, From 2dbe4c1d942c825ccd8a6c7e954860e42d9f17ad Mon Sep 17 00:00:00 2001 From: Rahul Jain Date: Wed, 15 Oct 2025 21:29:48 +0530 Subject: [PATCH 3/3] chore: fix asset path again attempt #4 --- src/components/layout/footer.tsx | 6 ++---- src/components/layout/header.tsx | 6 ++---- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/src/components/layout/footer.tsx b/src/components/layout/footer.tsx index 94f4caf9..8c067d66 100644 --- a/src/components/layout/footer.tsx +++ b/src/components/layout/footer.tsx @@ -1,9 +1,6 @@ import Link from 'next/link'; import Image from 'next/image'; -// Import logo from public directory for GitHub Pages compatibility -import logoImage from '../../../public/mdg.png'; - export function Footer() { return (