Skip to content

Commit b67ba2a

Browse files
SkyThonkSkyThonk
committed
Add documentation, templates, and assets for portfolio
Introduced comprehensive documentation including guides for quick start, data structure, deployment, contributing, and changelog. Added GitHub issue and pull request templates, Firebase deployment workflow, and initial screenshots for the portfolio. Updated README.md to reflect new documentation and project structure.
1 parent 287b8b4 commit b67ba2a

30 files changed

Lines changed: 2809 additions & 26 deletions

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or issue
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## 🐛 Bug Description
10+
A clear and concise description of what the bug is.
11+
12+
## 📋 Steps to Reproduce
13+
1. Go to '...'
14+
2. Click on '...'
15+
3. Scroll down to '...'
16+
4. See error
17+
18+
## ✅ Expected Behavior
19+
A clear description of what you expected to happen.
20+
21+
## ❌ Actual Behavior
22+
What actually happened.
23+
24+
## 📸 Screenshots
25+
If applicable, add screenshots to help explain your problem.
26+
27+
## 💻 Environment
28+
- OS: [e.g., Windows 11, macOS 14, Ubuntu 22.04]
29+
- Browser: [e.g., Chrome 120, Firefox 121, Safari 17]
30+
- Node Version: [e.g., v18.17.0]
31+
- Angular CLI Version: [e.g., 20.3.10]
32+
- npm Version: [e.g., 9.8.1]
33+
34+
## 📝 Additional Context
35+
Add any other context about the problem here.
36+
37+
## 🔍 Console Errors
38+
```
39+
Paste any console errors here
40+
```
41+
42+
## 🔗 Related Issues
43+
Link to any related issues here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## 💡 Feature Description
10+
A clear and concise description of the feature you'd like to see.
11+
12+
## 🎯 Problem Statement
13+
Describe the problem this feature would solve. Example: "I'm always frustrated when..."
14+
15+
## 🎨 Proposed Solution
16+
Describe how you envision this feature working.
17+
18+
## 🔄 Alternatives Considered
19+
Describe any alternative solutions or features you've considered.
20+
21+
## 📸 Mockups/Examples
22+
If applicable, add mockups, sketches, or links to examples of similar features.
23+
24+
## ✨ Benefits
25+
- Benefit 1
26+
- Benefit 2
27+
- Benefit 3
28+
29+
## 📝 Additional Context
30+
Add any other context, screenshots, or examples about the feature request here.
31+
32+
## 🎯 Priority
33+
How important is this feature to you?
34+
- [ ] Critical (blocking my usage)
35+
- [ ] High (would significantly improve experience)
36+
- [ ] Medium (nice to have)
37+
- [ ] Low (minor improvement)
38+
39+
## 🙋 Contribution
40+
- [ ] I would be willing to implement this feature
41+
- [ ] I would like someone else to implement this
42+
- [ ] I'm open to either

‎.github/ISSUE_TEMPLATE/help_wanted.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Help Wanted
3+
about: Get help with setup or customization
4+
title: '[HELP] '
5+
labels: question
6+
assignees: ''
7+
---
8+
9+
## ❓ Question/Issue
10+
Describe what you need help with.
11+
12+
## 📋 What I've Tried
13+
- Step 1 that I tried
14+
- Step 2 that I tried
15+
- Etc.
16+
17+
## 💻 Environment
18+
- OS: [e.g., Windows 11]
19+
- Node Version: [e.g., v18.17.0]
20+
- npm Version: [e.g., 9.8.1]
21+
22+
## 📝 Error Messages
23+
```
24+
Paste any error messages here
25+
```
26+
27+
## 📸 Screenshots
28+
If applicable, add screenshots.
29+
30+
## 🔗 Related Documentation
31+
Have you checked the documentation?
32+
- [ ] README.md
33+
- [ ] QUICK-START.md
34+
- [ ] PORTFOLIO-DATA-GUIDE.md
35+
- [ ] FIREBASE-DEPLOYMENT.md
36+
37+
## 📝 Additional Context
38+
Any other information that might help.

‎.github/pull_request_template.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Pull Request
2+
3+
## 📝 Description
4+
<!-- Provide a clear description of what this PR does -->
5+
6+
## 🎯 Type of Change
7+
<!-- Mark the relevant option with an 'x' -->
8+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
9+
- [ ] ✨ New feature (non-breaking change which adds functionality)
10+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
11+
- [ ] 📝 Documentation update
12+
- [ ] 🎨 Style/UI update (no functional changes)
13+
- [ ] ♻️ Refactoring (no functional changes)
14+
- [ ] ⚡ Performance improvement
15+
- [ ] ✅ Test addition or update
16+
17+
## 🔗 Related Issues
18+
<!-- Link to related issues using #issue_number -->
19+
Closes #
20+
Fixes #
21+
Related to #
22+
23+
## 🧪 Testing
24+
<!-- Describe the tests you ran and how to reproduce them -->
25+
26+
### Test Configuration
27+
- [ ] Tested locally with `npm start`
28+
- [ ] Production build tested with `npm run build`
29+
- [ ] Tested on Chrome
30+
- [ ] Tested on Firefox
31+
- [ ] Tested on Safari
32+
- [ ] Tested on mobile devices
33+
- [ ] All existing tests pass
34+
35+
### Test Steps
36+
1. Step 1
37+
2. Step 2
38+
3. Step 3
39+
40+
## 📸 Screenshots/Videos
41+
<!-- If applicable, add screenshots or videos to demonstrate the changes -->
42+
43+
### Before
44+
<!-- Screenshot of the old behavior -->
45+
46+
### After
47+
<!-- Screenshot of the new behavior -->
48+
49+
## ✅ Checklist
50+
<!-- Mark completed items with an 'x' -->
51+
- [ ] My code follows the style guidelines of this project
52+
- [ ] I have performed a self-review of my own code
53+
- [ ] I have commented my code, particularly in hard-to-understand areas
54+
- [ ] I have made corresponding changes to the documentation
55+
- [ ] My changes generate no new warnings or errors
56+
- [ ] I have added tests that prove my fix is effective or that my feature works
57+
- [ ] New and existing unit tests pass locally with my changes
58+
- [ ] Any dependent changes have been merged and published
59+
60+
## 📚 Documentation
61+
<!-- List any documentation that was updated or needs to be updated -->
62+
- [ ] README.md
63+
- [ ] PORTFOLIO-DATA-GUIDE.md
64+
- [ ] FIREBASE-DEPLOYMENT.md
65+
- [ ] Code comments
66+
- [ ] Other: ___________
67+
68+
## 🚀 Deployment Notes
69+
<!-- Any special deployment considerations? -->
70+
71+
## 💬 Additional Notes
72+
<!-- Any additional information that reviewers should know -->
73+
74+
---
75+
76+
**By submitting this pull request, I confirm that my contribution is made under the terms of the MIT License.**

‎.github/workflows/firebase-hosting.yml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# GitHub Actions Workflow for Firebase Hosting Deployment
2+
#
3+
# This workflow automatically builds and deploys your portfolio to Firebase Hosting
4+
# when you push to the main branch.
5+
#
6+
# Setup Instructions:
7+
# 1. Go to Firebase Console > Project Settings > Service Accounts
8+
# 2. Click "Generate New Private Key" and download the JSON file
9+
# 3. Go to your GitHub repo > Settings > Secrets and variables > Actions
10+
# 4. Create a new secret named FIREBASE_SERVICE_ACCOUNT
11+
# 5. Paste the entire contents of the JSON file as the value
12+
# 6. Update projectId below with your Firebase project ID
13+
14+
name: Deploy to Firebase Hosting
15+
16+
on:
17+
push:
18+
branches:
19+
- main
20+
pull_request:
21+
branches:
22+
- main
23+
24+
jobs:
25+
build_and_deploy:
26+
runs-on: ubuntu-latest
27+
28+
steps:
29+
- name: 📥 Checkout code
30+
uses: actions/checkout@v4
31+
32+
- name: 🔧 Setup Node.js
33+
uses: actions/setup-node@v4
34+
with:
35+
node-version: '18'
36+
cache: 'npm'
37+
38+
- name: 📦 Install dependencies
39+
run: npm ci
40+
41+
- name: 🏗️ Build project
42+
run: npm run build
43+
44+
- name: 🚀 Deploy to Firebase (Production)
45+
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
46+
uses: FirebaseExtended/action-hosting-deploy@v0
47+
with:
48+
repoToken: '${{ secrets.GITHUB_TOKEN }}'
49+
firebaseServiceAccount: '${{ secrets.FIREBASE_SERVICE_ACCOUNT }}'
50+
channelId: live
51+
projectId: your-project-id # TODO: Replace with your Firebase project ID
52+
env:
53+
FIREBASE_CLI_EXPERIMENTS: webframeworks
54+
55+
- name: 🔍 Deploy to Firebase (Preview)
56+
if: github.event_name == 'pull_request'
57+
uses: FirebaseExtended/action-hosting-deploy@v0
58+
with:
59+
repoToken: '${{ secrets.GITHUB_TOKEN }}'
60+
firebaseServiceAccount: '${{ secrets.FIREBASE_SERVICE_ACCOUNT }}'
61+
projectId: your-project-id # TODO: Replace with your Firebase project ID
62+
env:
63+
FIREBASE_CLI_EXPERIMENTS: webframeworks

‎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+
## [Unreleased]
9+
10+
### Added
11+
- Initial portfolio template with Angular 20
12+
- Complete documentation suite
13+
- README.md - Main documentation
14+
- QUICK-START.md - 10-minute setup guide
15+
- PORTFOLIO-DATA-GUIDE.md - JSON structure reference
16+
- FIREBASE-DEPLOYMENT.md - Deployment guide
17+
- CONTRIBUTING.md - Contribution guidelines
18+
- JSON-based content management system
19+
- Responsive design for all screen sizes
20+
- Dark/Light theme support
21+
- Portfolio sections:
22+
- Hero/Landing section
23+
- About me with quick facts
24+
- Experience timeline
25+
- Education history
26+
- Skills showcase with icons
27+
- Production projects gallery
28+
- Sample projects with GitHub links
29+
- Testimonials carousel
30+
- Contact section
31+
- Scroll animations
32+
- GitHub issue and PR templates
33+
- MIT License
34+
35+
### Changed
36+
- N/A
37+
38+
### Deprecated
39+
- N/A
40+
41+
### Removed
42+
- N/A
43+
44+
### Fixed
45+
- N/A
46+
47+
### Security
48+
- N/A
49+
50+
---
51+
52+
## [1.0.0] - 2025-11-17
53+
54+
### Added
55+
- Initial release
56+
- Portfolio template with customizable JSON data
57+
- Firebase deployment configuration
58+
- Comprehensive documentation
59+
60+
---
61+
62+
## Version Format
63+
64+
- **[Unreleased]** - Changes that are in development
65+
- **[X.Y.Z]** - Released versions
66+
- **X** (Major) - Breaking changes
67+
- **Y** (Minor) - New features, backwards compatible
68+
- **Z** (Patch) - Bug fixes, backwards compatible
69+
70+
## Change Categories
71+
72+
- **Added** - New features
73+
- **Changed** - Changes in existing functionality
74+
- **Deprecated** - Soon-to-be removed features
75+
- **Removed** - Removed features
76+
- **Fixed** - Bug fixes
77+
- **Security** - Vulnerability fixes
78+
79+
---
80+
81+
[Unreleased]: https://github.com/SkyThonk/PortfolioJSON/compare/v1.0.0...HEAD
82+
[1.0.0]: https://github.com/SkyThonk/PortfolioJSON/releases/tag/v1.0.0

0 commit comments

Comments
 (0)