chore: fix asset path again and refactor pull_request template
This commit is contained in:
Rahul Jain
@@ -1,42 +1,174 @@
|
||||
<!--
|
||||
For Work In Progress Pull Requests, please use the Draft PR feature,
|
||||
see https://github.blog/2019-02-14-introducing-draft-pull-requests/ for further details.
|
||||
🚀 Thanks for contributing to GitHub Profile README Generator V2!
|
||||
|
||||
For a timely review/response, please avoid force-pushing additional
|
||||
commits if your PR already received reviews or comments.
|
||||
Before submitting your Pull Request, please ensure you've done the following:
|
||||
📖 Read the Contributing Guide: https://github.com/rahuldkjain/github-profile-readme-generator/blob/master/CONTRIBUTING.md
|
||||
📖 Read the Code of Conduct: https://github.com/rahuldkjain/github-profile-readme-generator/blob/master/CODE_OF_CONDUCT.md
|
||||
🔄 Follow our Commit Convention: https://github.com/rahuldkjain/github-profile-readme-generator/blob/master/COMMIT_CONVENTION.md
|
||||
👷♀️ Create focused, single-purpose PRs
|
||||
✅ Test your changes thoroughly
|
||||
📝 Use conventional commit messages (feat:, fix:, docs:, etc.)
|
||||
📗 Update documentation and add screenshots for UI changes
|
||||
|
||||
Before submitting a Pull Request, please ensure you've done the following:
|
||||
- 📖 Read the Contributing Guide: https://github.com/rahuldkjain/github-profile-readme-generator/blob/master/CONTRIBUTING.md#create-a-pull-request.
|
||||
- 📖 Read the Code of Conduct: https://github.com/rahuldkjain/github-profile-readme-generator/blob/master/CODE_OF_CONDUCT.md.
|
||||
- 👷♀️ Create small PRs. In most cases this will be possible.
|
||||
- ✅ Provide issue number with link.
|
||||
- 📝 Use descriptive commit messages.
|
||||
- 📗 Update any related documentation and include any relevant screenshots.
|
||||
For Work In Progress PRs, please use the Draft PR feature.
|
||||
Avoid force-pushing after receiving reviews unless requested.
|
||||
-->
|
||||
|
||||
## What type of PR is this? (check all applicable)
|
||||
# 🔄 Pull Request
|
||||
|
||||
- [ ] Refactor
|
||||
- [ ] Feature
|
||||
- [ ] Bug Fix
|
||||
- [ ] Enhancement
|
||||
- [ ] Documentation Update
|
||||
## 📋 **Type of Change** (check all applicable)
|
||||
|
||||
## Description
|
||||
- [ ] 🐛 **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
|
||||
|
||||
## Related Tickets & Documents
|
||||
## 📖 **Description**
|
||||
|
||||
## QA Instructions, Screenshots, Recordings
|
||||
<!-- Provide a clear and concise description of what this PR does -->
|
||||
|
||||
_Please replace this line with instructions on how to test your changes, as well
|
||||
as any relevant images for UI changes._
|
||||
### **What changed?**
|
||||
|
||||
<!-- ## Added tests?
|
||||
<!-- Describe the changes made -->
|
||||
|
||||
- [ ] yes
|
||||
- [ ] no, because they aren't needed
|
||||
- [ ] no, because I need help -->
|
||||
### **Why was this change made?**
|
||||
|
||||
## Added to documentation?
|
||||
<!-- Explain the motivation behind this change -->
|
||||
|
||||
- [ ] readme
|
||||
### **How does this change help users?**
|
||||
|
||||
<!-- Describe the user benefit -->
|
||||
|
||||
## 🔗 **Related Issues**
|
||||
|
||||
<!-- Link related issues using keywords: Closes #123, Fixes #456, Related to #789 -->
|
||||
|
||||
- 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**
|
||||
|
||||
<!-- Provide step-by-step instructions for reviewers to test your changes -->
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
### **Expected Behavior**
|
||||
|
||||
<!-- Describe what should happen when testing -->
|
||||
|
||||
## 📸 **Screenshots/Recordings**
|
||||
|
||||
<!--
|
||||
For UI changes, please include:
|
||||
- Before/after screenshots
|
||||
- Mobile screenshots
|
||||
- Dark/light theme screenshots
|
||||
- Screen recordings for complex interactions
|
||||
-->
|
||||
|
||||
### **Before**
|
||||
|
||||
<!-- Screenshot/description of current state -->
|
||||
|
||||
### **After**
|
||||
|
||||
<!-- Screenshot/description of new state -->
|
||||
|
||||
## 📋 **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**
|
||||
|
||||
<!-- Any special considerations for deployment -->
|
||||
|
||||
- [ ] **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
|
||||
|
||||
## 📝 **Additional Notes**
|
||||
|
||||
<!-- Any additional information, concerns, or context -->
|
||||
|
||||
## 👀 **Reviewers**
|
||||
|
||||
<!-- Tag specific reviewers if needed -->
|
||||
<!-- @username for specific reviewers -->
|
||||
|
||||
---
|
||||
|
||||
**By submitting this PR, I confirm that:**
|
||||
|
||||
- ✅ 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
|
||||
|
||||
@@ -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 (
|
||||
|
||||
@@ -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: '/' },
|
||||
|
||||
Reference in New Issue
Block a user