Skip to content

Commit f43b859

Browse files
rahuldkjainrahuldkjain
authored
Merge pull request #927 from rahuldkjain/dev
chore: fix logo issues and add documentation
2 parents 957332f + 723efd9 commit f43b859

File tree

5 files changed

+337
-25
lines changed

5 files changed

+337
-25
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 31 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,50 @@
11
---
2-
name: Bug report
3-
about: Create a report to help us improve
4-
title: ''
5-
labels: bug
2+
name: 🐛 Bug Report
3+
about: Report a bug in GitHub Profile README Generator
4+
title: '[Bug] '
5+
labels: ['bug']
66
assignees: ''
77
---
88

9-
**Describe the bug**
9+
## 🐛 Bug Description
10+
1011
A clear and concise description of what the bug is.
1112

12-
**To Reproduce**
13-
Steps to reproduce the behavior:
13+
## 🔄 Steps to Reproduce
1414

15-
1. Go to '...'
16-
2. Click on '....'
17-
3. Scroll down to '....'
15+
1. Go to [URL or page]
16+
2. Click on [element]
17+
3. Fill in [specific fields]
1818
4. See error
1919

20-
**Expected behavior**
21-
A clear and concise description of what you expected to happen.
20+
## ✅ Expected Behavior
21+
22+
A clear description of what you expected to happen.
23+
24+
## 📸 Screenshots
2225

23-
**Screenshots**
2426
If applicable, add screenshots to help explain your problem.
2527

26-
**Desktop (please complete the following information):**
28+
## 🖥️ Environment
29+
30+
**Desktop:**
31+
32+
- OS: [e.g. macOS, Windows, Linux]
33+
- Browser: [e.g. Chrome 118, Safari 17, Firefox 119]
34+
35+
**Mobile:**
2736

28-
- OS: [e.g. iOS]
29-
- Browser [e.g. chrome, safari]
30-
- Version [e.g. 22]
37+
- Device: [e.g. iPhone 15, Samsung Galaxy S23]
38+
- OS: [e.g. iOS 17.1, Android 14]
39+
- Browser: [e.g. Safari, Chrome Mobile]
3140

32-
**Smartphone (please complete the following information):**
41+
## 🔧 Additional Context
3342

34-
- Device: [e.g. iPhone6]
35-
- OS: [e.g. iOS8.1]
36-
- Browser [e.g. stock browser, safari]
37-
- Version [e.g. 22]
43+
- Does this happen in incognito/private mode? [Yes/No]
44+
- Console errors (if any): [Paste console output]
45+
- Network connectivity: [Good/Slow/Offline]
3846

39-
**Additional context**
40-
Add any other context about the problem here.
47+
**Note:** Please test at the current version: https://rahuldkjain.github.io/gh-profile-readme-generator
4148

4249
Join the **Discord Server** for further discussions.
4350

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
name: ✨ Feature Request
3+
about: Suggest a new feature for GitHub Profile README Generator
4+
title: '[Feature] '
5+
labels: ['enhancement']
6+
assignees: ''
7+
---
8+
9+
## ✨ Feature Description
10+
11+
A clear and concise description of the feature you'd like to see.
12+
13+
## 🎯 Problem Statement
14+
15+
What problem does this feature solve? Is your feature request related to a problem?
16+
17+
## 💡 Proposed Solution
18+
19+
Describe the solution you'd like to see implemented.
20+
21+
## 🔄 User Flow
22+
23+
Describe how a user would interact with this feature:
24+
25+
1. User goes to...
26+
2. User clicks/types...
27+
3. System responds with...
28+
29+
## 🎨 Design Considerations
30+
31+
- UI/UX requirements
32+
- Accessibility considerations
33+
- Mobile responsiveness needs
34+
- Theme compatibility (dark/light mode)
35+
36+
## 🔧 Technical Considerations
37+
38+
- Performance impact
39+
- Browser compatibility requirements
40+
- Dependencies needed
41+
- Potential breaking changes
42+
43+
## 📋 Alternative Solutions
44+
45+
Describe alternatives you've considered.
46+
47+
## 📸 Mockups/Examples
48+
49+
If applicable, add mockups, sketches, or examples from other tools.
50+
51+
## 🎯 Priority
52+
53+
- [ ] Low - Nice to have
54+
- [ ] Medium - Would improve UX significantly
55+
- [ ] High - Critical for user workflow
56+
- [ ] Critical - Blocking current functionality
57+
58+
## 📱 Target Platforms
59+
60+
- [ ] Desktop
61+
- [ ] Mobile
62+
- [ ] Tablet
63+
- [ ] All platforms
64+
65+
---
66+
67+
💬 **Join our Discord** for feature discussions: https://discord.gg/HHMs7Eg

‎CHANGELOG.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [2.0.0] - 2025-10-15
9+
10+
### ✨ Features
11+
12+
- **Complete rewrite**: Migrated to Next.js 15 with App Router and Turbopack
13+
- **React 19**: Updated to latest React with concurrent features
14+
- **TypeScript 5**: Full type safety with strict configuration
15+
- **Modern UI**: Tailwind CSS 4 with design tokens and CSS variables
16+
- **Accessibility**: WCAG 2.1 AA compliance with accessibility menu
17+
- **Privacy**: GDPR-compliant analytics with opt-in consent
18+
- **Performance**: 3x faster builds and 50% smaller bundle size
19+
- **Auto-fill**: GitHub integration for automatic profile data
20+
- **Export/Import**: JSON functionality for profile data
21+
- **Enhanced UX**: Multi-step wizard with real-time validation
22+
- **Responsive**: Mobile-first design with touch optimization
23+
24+
### 🐛 Bug Fixes
25+
26+
- Fixed skill selection persistence across sessions
27+
- Resolved theme toggle flickering on page load
28+
- Fixed social media icon alignment issues
29+
- Corrected markdown preview rendering edge cases
30+
31+
### ⚡ Performance Improvements
32+
33+
- Implemented code splitting with lazy loading
34+
- Optimized bundle size with Turbopack
35+
- Added image optimization for better loading
36+
- Reduced JavaScript bundle by 50%
37+
38+
### ♻️ Code Refactoring
39+
40+
- Migrated from Gatsby to Next.js 15
41+
- Converted all components to TypeScript
42+
- Implemented modern React patterns (hooks, context)
43+
- Restructured project architecture for scalability
44+
45+
### 📚 Documentation
46+
47+
- Added comprehensive TypeScript documentation
48+
- Created accessibility guidelines
49+
- Updated deployment documentation
50+
- Added contributing guidelines for V2
51+
52+
### 🏗️ Build System
53+
54+
- Migrated to Next.js build system
55+
- Added Turbopack for development
56+
- Implemented ESLint + Prettier configuration
57+
- Added Vitest for testing
58+
59+
### 👷 Continuous Integration
60+
61+
- Enhanced GitHub Actions workflows
62+
- Added preview deployments with environment tracking
63+
- Implemented automated release management
64+
- Added comprehensive testing pipeline
65+
66+
---
67+
68+
## Previous Versions (V1)
69+
70+
For changes in V1, see the [V1 Release Archive](https://github.com/rahuldkjain/github-profile-readme-generator/releases?q=v1&expanded=true).
71+
72+
### Migration from V1 to V2
73+
74+
V2 represents a complete rewrite with breaking changes:
75+
76+
- **Technology Stack**: Gatsby → Next.js 15
77+
- **Styling**: CSS Modules → Tailwind CSS 4
78+
- **State Management**: Local state → Zustand + localStorage
79+
- **Build System**: Webpack → Turbopack
80+
- **Type Safety**: JavaScript → TypeScript 5
81+
82+
All V1 functionality has been preserved and enhanced in V2. See [MIGRATION_STRATEGY.md](./MIGRATION_STRATEGY.md) for detailed migration information.

‎COMMIT_CONVENTION.md‎

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
# 📝 Commit Message Convention
2+
3+
This project follows [Conventional Commits](https://www.conventionalcommits.org/) specification for automated changelog generation and semantic versioning.
4+
5+
## Format
6+
7+
```
8+
<type>[optional scope]: <description>
9+
10+
[optional body]
11+
12+
[optional footer(s)]
13+
```
14+
15+
## Types
16+
17+
| Type | Description | Version Bump |
18+
| ---------- | ------------------------ | ------------ |
19+
| `feat` | New feature | Minor |
20+
| `fix` | Bug fix | Patch |
21+
| `perf` | Performance improvement | Patch |
22+
| `refactor` | Code refactoring | Patch |
23+
| `docs` | Documentation changes | Patch |
24+
| `style` | Code style changes | Patch |
25+
| `test` | Adding or updating tests | Patch |
26+
| `build` | Build system changes | Patch |
27+
| `ci` | CI/CD changes | Patch |
28+
| `chore` | Maintenance tasks | No bump |
29+
30+
## Breaking Changes
31+
32+
Add `BREAKING CHANGE:` in the footer or `!` after type to indicate breaking changes:
33+
34+
```bash
35+
feat!: remove deprecated API endpoints
36+
37+
BREAKING CHANGE: The old API endpoints have been removed. Use the new v2 endpoints instead.
38+
```
39+
40+
## Examples
41+
42+
### Features
43+
44+
```bash
45+
feat: add GitHub auto-fill integration
46+
feat(ui): implement dark mode toggle
47+
feat!: migrate to Next.js 15 App Router
48+
```
49+
50+
### Bug Fixes
51+
52+
```bash
53+
fix: resolve skill selection persistence issue
54+
fix(mobile): correct responsive navigation layout
55+
fix(a11y): improve keyboard navigation for forms
56+
```
57+
58+
### Performance
59+
60+
```bash
61+
perf: optimize image loading with next/image
62+
perf(build): reduce bundle size by 30%
63+
```
64+
65+
### Documentation
66+
67+
```bash
68+
docs: update installation instructions
69+
docs(api): add TypeScript examples
70+
docs(readme): fix broken demo links
71+
```
72+
73+
### Refactoring
74+
75+
```bash
76+
refactor: convert components to TypeScript
77+
refactor(store): migrate to Zustand state management
78+
```
79+
80+
## Scopes (Optional)
81+
82+
Use scopes to indicate the area of change:
83+
84+
- `ui` - User interface components
85+
- `api` - API related changes
86+
- `build` - Build system
87+
- `ci` - Continuous integration
88+
- `docs` - Documentation
89+
- `test` - Testing
90+
- `a11y` - Accessibility
91+
- `perf` - Performance
92+
- `mobile` - Mobile-specific changes
93+
94+
## Tools
95+
96+
### Commitizen (Recommended)
97+
98+
Install commitizen for interactive commit messages:
99+
100+
```bash
101+
npm install -g commitizen cz-conventional-changelog
102+
echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc
103+
```
104+
105+
Use `git cz` instead of `git commit`:
106+
107+
```bash
108+
git add .
109+
git cz
110+
```
111+
112+
### VS Code Extension
113+
114+
Install "Conventional Commits" extension for VS Code to get commit message templates.
115+
116+
## Automated Release Process
117+
118+
1. **Commit** using conventional format
119+
2. **Push** to master branch
120+
3. **Release Please** analyzes commits
121+
4. **Creates PR** with changelog and version bump
122+
5. **Merge PR** to trigger release and deployment
123+
124+
## Examples in Practice
125+
126+
```bash
127+
# Adding new feature
128+
git commit -m "feat(ui): add accessibility menu with font size controls"
129+
130+
# Fixing bug
131+
git commit -m "fix(mobile): resolve navigation menu overflow on small screens"
132+
133+
# Breaking change
134+
git commit -m "feat!: migrate to Next.js 15 App Router
135+
136+
BREAKING CHANGE: Pages directory structure has changed.
137+
See migration guide for updating custom pages."
138+
139+
# Performance improvement
140+
git commit -m "perf(build): implement code splitting for 50% bundle reduction"
141+
142+
# Documentation update
143+
git commit -m "docs(contributing): add TypeScript coding standards"
144+
```
145+
146+
## Benefits
147+
148+
- ✅ **Automated changelogs** - No manual changelog maintenance
149+
- ✅ **Semantic versioning** - Automatic version bumps based on commit types
150+
- ✅ **Release notes** - Rich, categorized release notes
151+
- ✅ **Consistency** - Standardized commit history
152+
- ✅ **Tooling integration** - Works with Release Please, semantic-release, etc.

0 commit comments

Comments
 (0)