Skip to content

Commit 0536c90

Browse files
rahuldkjainrahuldkjain
authored
Merge pull request #930 from rahuldkjain/dev
Dev
2 parents 1932af0 + 2dbe4c1 commit 0536c90

File tree

3 files changed

+166
-38
lines changed

3 files changed

+166
-38
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 162 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,174 @@
11
<!--
2-
For Work In Progress Pull Requests, please use the Draft PR feature,
3-
see https://github.blog/2019-02-14-introducing-draft-pull-requests/ for further details.
4-
5-
For a timely review/response, please avoid force-pushing additional
6-
commits if your PR already received reviews or comments.
7-
8-
Before submitting a Pull Request, please ensure you've done the following:
9-
- 📖 Read the Contributing Guide: https://github.com/rahuldkjain/github-profile-readme-generator/blob/master/CONTRIBUTING.md#create-a-pull-request.
10-
- 📖 Read the Code of Conduct: https://github.com/rahuldkjain/github-profile-readme-generator/blob/master/CODE_OF_CONDUCT.md.
11-
- 👷‍♀️ Create small PRs. In most cases this will be possible.
12-
- ✅ Provide issue number with link.
13-
- 📝 Use descriptive commit messages.
14-
- 📗 Update any related documentation and include any relevant screenshots.
2+
🚀 Thanks for contributing to GitHub Profile README Generator V2!
3+
4+
Before submitting your Pull Request, please ensure you've done the following:
5+
📖 Read the Contributing Guide: https://github.com/rahuldkjain/github-profile-readme-generator/blob/master/CONTRIBUTING.md
6+
📖 Read the Code of Conduct: https://github.com/rahuldkjain/github-profile-readme-generator/blob/master/CODE_OF_CONDUCT.md
7+
🔄 Follow our Commit Convention: https://github.com/rahuldkjain/github-profile-readme-generator/blob/master/COMMIT_CONVENTION.md
8+
👷‍♀️ Create focused, single-purpose PRs
9+
✅ Test your changes thoroughly
10+
📝 Use conventional commit messages (feat:, fix:, docs:, etc.)
11+
📗 Update documentation and add screenshots for UI changes
12+
13+
For Work In Progress PRs, please use the Draft PR feature.
14+
Avoid force-pushing after receiving reviews unless requested.
1515
-->
1616

17-
## What type of PR is this? (check all applicable)
17+
# 🔄 Pull Request
18+
19+
## 📋 **Type of Change** (check all applicable)
20+
21+
- [ ] 🐛 **Bug Fix** - Fixes an issue without breaking existing functionality
22+
- [ ] ✨ **Feature** - Adds new functionality
23+
- [ ] ⚡ **Performance** - Improves performance without changing functionality
24+
- [ ] ♻️ **Refactor** - Code changes that neither fix bugs nor add features
25+
- [ ] 📚 **Documentation** - Updates to documentation, comments, or README
26+
- [ ] 🎨 **Style** - Code style changes (formatting, missing semi-colons, etc.)
27+
- [ ] 🧪 **Test** - Adding or updating tests
28+
- [ ] 🏗️ **Build** - Changes to build system or dependencies
29+
- [ ] 👷 **CI/CD** - Changes to CI/CD workflows
30+
- [ ] 🔒 **Security** - Security improvements or vulnerability fixes
31+
- [ ] ♿ **Accessibility** - Improves accessibility compliance
32+
- [ ] 📱 **Mobile** - Mobile-specific improvements
33+
- [ ] 🌐 **i18n** - Internationalization changes
34+
35+
## 📖 **Description**
36+
37+
<!-- Provide a clear and concise description of what this PR does -->
38+
39+
### **What changed?**
40+
41+
<!-- Describe the changes made -->
42+
43+
### **Why was this change made?**
44+
45+
<!-- Explain the motivation behind this change -->
46+
47+
### **How does this change help users?**
48+
49+
<!-- Describe the user benefit -->
50+
51+
## 🔗 **Related Issues**
52+
53+
<!-- Link related issues using keywords: Closes #123, Fixes #456, Related to #789 -->
54+
55+
- Closes #
56+
- Fixes #
57+
- Related to #
58+
59+
## 🧪 **Testing & Quality Assurance**
60+
61+
### **Testing Done** (check all applicable)
62+
63+
- [ ] ✅ **Manual testing** - Tested functionality manually
64+
- [ ] 🧪 **Unit tests** - Added/updated unit tests
65+
- [ ] 🔄 **Integration tests** - Tested with other components
66+
- [ ] 📱 **Mobile testing** - Tested on mobile devices
67+
- [ ] ♿ **Accessibility testing** - Tested with screen readers/keyboard nav
68+
- [ ] 🌐 **Cross-browser testing** - Tested in multiple browsers
69+
- [ ] 🎨 **Visual testing** - Checked UI/UX in light/dark themes
70+
71+
### **Test Instructions**
72+
73+
<!-- Provide step-by-step instructions for reviewers to test your changes -->
74+
75+
1.
76+
2.
77+
3.
78+
79+
### **Expected Behavior**
80+
81+
<!-- Describe what should happen when testing -->
82+
83+
## 📸 **Screenshots/Recordings**
84+
85+
<!--
86+
For UI changes, please include:
87+
- Before/after screenshots
88+
- Mobile screenshots
89+
- Dark/light theme screenshots
90+
- Screen recordings for complex interactions
91+
-->
92+
93+
### **Before**
94+
95+
<!-- Screenshot/description of current state -->
96+
97+
### **After**
98+
99+
<!-- Screenshot/description of new state -->
100+
101+
## 📋 **Checklist**
102+
103+
### **Code Quality**
104+
105+
- [ ] 🔍 **TypeScript** - No TypeScript errors (`npm run type-check`)
106+
- [ ] 🧹 **Linting** - No ESLint errors (`npm run lint`)
107+
- [ ] 🎨 **Formatting** - Code is properly formatted (`npm run format`)
108+
- [ ] 🏗️ **Build** - Production build succeeds (`npm run build`)
109+
- [ ] ⚡ **Performance** - No performance regressions introduced
110+
111+
### **Accessibility**
112+
113+
- [ ] ♿ **WCAG Compliance** - Follows WCAG 2.1 AA guidelines
114+
- [ ] ⌨️ **Keyboard Navigation** - All interactive elements are keyboard accessible
115+
- [ ] 🔍 **Screen Reader** - Proper ARIA labels and semantic HTML
116+
- [ ] 🎨 **Color Contrast** - Meets contrast requirements
117+
- [ ] 🎯 **Focus Management** - Visible focus indicators
118+
119+
### **Mobile & Responsive**
120+
121+
- [ ] 📱 **Mobile Responsive** - Works on mobile devices (320px+)
122+
- [ ] 🖥️ **Desktop** - Works on desktop (1024px+)
123+
- [ ] 📐 **Tablet** - Works on tablet sizes (768px+)
124+
- [ ] 🔄 **Orientation** - Works in portrait and landscape
125+
126+
### **Browser Compatibility**
127+
128+
- [ ] 🌐 **Chrome** - Latest version
129+
- [ ] 🦊 **Firefox** - Latest version
130+
- [ ] 🧭 **Safari** - Latest version
131+
- [ ] 📱 **Mobile Safari** - iOS Safari
132+
- [ ] 📱 **Chrome Mobile** - Android Chrome
133+
134+
### **Documentation**
135+
136+
- [ ] 📚 **Code Comments** - Added helpful comments for complex logic
137+
- [ ] 📖 **Documentation** - Updated relevant documentation
138+
- [ ] 📝 **README** - Updated README if needed
139+
- [ ] 🔄 **Changelog** - Will be auto-generated from conventional commits
140+
141+
### **Security & Privacy**
142+
143+
- [ ] 🔒 **No Secrets** - No API keys, passwords, or sensitive data exposed
144+
- [ ] 🛡️ **Input Validation** - Proper validation for user inputs
145+
- [ ] 🔐 **XSS Prevention** - Protected against XSS attacks
146+
- [ ] 🍪 **Privacy Compliant** - Follows GDPR/privacy requirements
147+
148+
## 🚀 **Deployment Notes**
18149

19-
- [ ] Refactor
20-
- [ ] Feature
21-
- [ ] Bug Fix
22-
- [ ] Enhancement
23-
- [ ] Documentation Update
150+
<!-- Any special considerations for deployment -->
24151

25-
## Description
152+
- [ ] **No breaking changes** - Backward compatible
153+
- [ ] **Database changes** - N/A (static site)
154+
- [ ] **Environment variables** - No new env vars needed
155+
- [ ] **Third-party dependencies** - No new external dependencies
26156

27-
## Related Tickets & Documents
157+
## 📝 **Additional Notes**
28158

29-
## QA Instructions, Screenshots, Recordings
159+
<!-- Any additional information, concerns, or context -->
30160

31-
_Please replace this line with instructions on how to test your changes, as well
32-
as any relevant images for UI changes._
161+
## 👀 **Reviewers**
33162

34-
<!-- ## Added tests?
163+
<!-- Tag specific reviewers if needed -->
164+
<!-- @username for specific reviewers -->
35165

36-
- [ ] yes
37-
- [ ] no, because they aren't needed
38-
- [ ] no, because I need help -->
166+
---
39167

40-
## Added to documentation?
168+
**By submitting this PR, I confirm that:**
41169

42-
- [ ] readme
170+
- ✅ I have read and agree to the [Code of Conduct](https://github.com/rahuldkjain/github-profile-readme-generator/blob/master/CODE_OF_CONDUCT.md)
171+
- ✅ I have followed the [Contributing Guidelines](https://github.com/rahuldkjain/github-profile-readme-generator/blob/master/CONTRIBUTING.md)
172+
- ✅ I have used [Conventional Commits](https://github.com/rahuldkjain/github-profile-readme-generator/blob/master/COMMIT_CONVENTION.md) for my commit messages
173+
- ✅ I have tested my changes thoroughly
174+
- ✅ My code follows the project's coding standards

‎src/components/layout/footer.tsx‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
11
import Link from 'next/link';
22
import Image from 'next/image';
33

4-
// Import the logo as a static asset for GitHub Pages compatibility
5-
import logoImage from '../../images/mdg.png';
6-
74
export function Footer() {
85
return (
96
<footer className="border-border bg-card border-t py-8">
107
<div className="container mx-auto px-4">
118
{/* Logo Section */}
129
<div className="mb-8 flex items-center justify-center gap-3">
1310
<Image
14-
src={logoImage}
11+
src="/mdg.png"
1512
alt="GitHub Profile README Generator Logo"
1613
width={48}
1714
height={48}
1815
className="h-12 w-12"
16+
unoptimized
1917
/>
2018
<span className="text-xl font-bold">GitHub Profile README Generator</span>
2119
</div>

‎src/components/layout/header.tsx‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@ import { ThemeToggle } from '@/components/ui/theme-toggle';
77
import { AccessibilityMenu } from '@/components/ui/accessibility-menu';
88
import { GitHubStats } from '@/components/ui/github-stats';
99

10-
// Import the logo as a static asset for GitHub Pages compatibility
11-
import logoImage from '../../images/mdg.png';
12-
1310
const navigation = [
1411
{ name: 'Generator', href: '/' },
1512
{ name: 'Addons', href: '/addons' },
@@ -33,12 +30,13 @@ export function Header({}: HeaderProps = {}) {
3330
<div className="flex items-center gap-4">
3431
<Link href="/" prefetch={true} className="flex items-center gap-3 hover:opacity-80">
3532
<Image
36-
src={logoImage}
33+
src="/mdg.png"
3734
alt="GitHub Profile README Generator Logo"
3835
width={40}
3936
height={40}
4037
className="h-10 w-10"
4138
priority
39+
unoptimized
4240
/>
4341
<span className="hidden text-xl font-bold sm:inline-block lg:text-2xl">
4442
GitHub Profile README Generator

0 commit comments

Comments
 (0)