Skip to content

Commit 26c5497

Browse files
ChoiKangMChoiKangM
committed
refactor: 초보자도 쉽게 사용할 수 있는 자기소개 페이지 템플릿으로 전면 개편
✨ 주요 변경사항: - README.md: 5분 만에 시작할 수 있는 친절한 가이드로 재작성 - index.html: 깔끔한 디자인 + 상세한 주석 추가 - QUICKSTART.md: 초보자를 위한 단계별 가이드 추가 - GitHub Actions: 자동 배포 워크플로우 설정 - examples/: 다양한 예제 템플릿 추가 🎯 개선사항: - 코딩 경험 없이도 5분 만에 시작 가능 - 반응형 디자인 (모바일/태블릿/PC 지원) - GitHub Pages 무료 호스팅 자동 설정 - 커스터마이징 가이드 및 예제 제공 - Issue 템플릿 및 기여 가이드 추가
1 parent c4f4ee6 commit 26c5497

15 files changed

Lines changed: 2927 additions & 348 deletions

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: 버그 리포트
3+
about: 버그를 발견하셨나요? 알려주세요!
4+
title: '[버그] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## 🐛 버그 설명
10+
버그에 대한 명확하고 간단한 설명을 작성해주세요.
11+
12+
## 📋 재현 방법
13+
버그를 재현하는 단계:
14+
1. '...'로 이동
15+
2. '...' 클릭
16+
3. '...'까지 스크롤
17+
4. 오류 발생
18+
19+
## 💡 예상 동작
20+
어떤 동작을 기대했는지 설명해주세요.
21+
22+
## 📸 스크린샷
23+
가능하다면 스크린샷을 첨부해주세요.
24+
25+
## 💻 환경
26+
- OS: [예: Windows 10, macOS 13, Linux]
27+
- 브라우저: [예: Chrome 120, Safari 17, Firefox 120]
28+
29+
## 📝 추가 정보
30+
버그와 관련된 추가 정보가 있다면 작성해주세요.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: 기능 제안
3+
about: 새로운 기능이나 개선사항을 제안해주세요!
4+
title: '[기능] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## 💡 기능 설명
10+
제안하고 싶은 기능에 대해 설명해주세요.
11+
12+
## �,95a5a6
13+
이 기능이 필요한 이유는 무엇인가요? 어떤 문제를 해결하나요?
14+
15+
## 📝 제안하는 해결 방법
16+
어떻게 구현되면 좋을지 설명해주세요.
17+
18+
## 🔀 다른 대안
19+
다른 방법이나 대안을 고려해보셨나요?
20+
21+
## 📸 예시/참고자료
22+
참고할 만한 예시나 링크가 있다면 공유해주세요.
23+
24+
## 📝 추가 정보
25+
더 추가하고 싶은 내용이 있다면 작성해주세요.

‎.github/workflows/pages.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: ["main", "master"]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: false
16+
17+
jobs:
18+
deploy:
19+
environment:
20+
name: github-pages
21+
url: ${{ steps.deployment.outputs.page_url }}
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v4
26+
27+
- name: Setup Pages
28+
uses: actions/configure-pages@v4
29+
30+
- name: Upload artifact
31+
uses: actions/upload-pages-artifact@v3
32+
with:
33+
path: '.'
34+
35+
- name: Deploy to GitHub Pages
36+
id: deployment
37+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# 시스템 파일
2+
.DS_Store
3+
Thumbs.db
4+
5+
# 에디터
6+
.vscode/
7+
.idea/
8+
*.swp
9+
*.swo
10+
11+
# 로그
12+
*.log
13+
14+
# 임시 파일
15+
*.tmp
16+
.cache/
17+
18+
# Node modules (if added later)
19+
node_modules/
20+
package-lock.json

‎CHANGES.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# 🎉 프로젝트 변경 완료!
2+
3+
## 📋 변경 사항 요약
4+
5+
이 레포지토리가 **초보자도 쉽게 자기소개 페이지를 만들 수 있는 템플릿**으로 완전히 새롭게 바뀌었습니다!
6+
7+
## ✨ 주요 변경사항
8+
9+
### 1. 📚 문서 개선
10+
- **README.md**: 초보자를 위한 친절한 단계별 가이드로 전면 재작성
11+
- **QUICKSTART.md**: 5분 만에 시작할 수 있는 빠른 시작 가이드 추가
12+
- **CONTRIBUTING.md**: 기여 가이드 추가
13+
14+
### 2. 🎨 템플릿 개선
15+
- **index.html**: 더 깔끔하고 현대적인 디자인으로 개선
16+
- 반응형 디자인 (모바일, 태블릿, PC 모두 지원)
17+
- 초보자를 위한 상세한 주석 (💡) 추가
18+
- 깔끔한 카드 스타일 섹션
19+
- 개선된 색상과 타이포그래피
20+
21+
### 3. 📦 새로운 파일들
22+
- **QUICKSTART.md**: 초보자를 위한 상세 가이드
23+
- **CONTRIBUTING.md**: 기여 가이드
24+
- **.gitignore**: 불필요한 파일 제외
25+
- **examples/**: 다양한 예제 템플릿
26+
- `with-photo.html`: 프로필 사진 포함 버전
27+
- `README.md`: 예제 설명
28+
29+
### 4. ⚙️ 자동화 설정
30+
- **/.github/workflows/pages.yml**: GitHub Pages 자동 배포 설정
31+
- **/.github/ISSUE_TEMPLATE/**: Issue 템플릿 추가
32+
- 버그 리포트 템플릿
33+
- 기능 제안 템플릿
34+
35+
### 5. 📦 Package.json 업데이트
36+
- 더 명확한 설명과 키워드
37+
- 로컬 개발을 위한 스크립트 개선
38+
39+
## 🎯 주요 개선점
40+
41+
### 초보자 친화적
42+
- ✅ 코딩 경험이 없어도 따라할 수 있는 단계별 가이드
43+
- ✅ 각 단계마다 스크린샷 설명 (문서에 추가 가능)
44+
- ✅ 모든 파일에 상세한 주석 추가
45+
46+
### 즉시 사용 가능
47+
- ✅ "Use this template" 버튼으로 즉시 시작
48+
- ✅ 텍스트만 변경하면 완성
49+
- ✅ GitHub Pages 자동 배포
50+
51+
### 확장 가능
52+
- ✅ 예제 파일로 쉽게 커스터마이징
53+
- ✅ 섹션 추가/제거 가이드
54+
- ✅ 색상, 폰트 변경 가이드
55+
56+
## 📋 다음 단계
57+
58+
### 사용자를 위해:
59+
1. README.md를 읽고 5분 만에 시작하기
60+
2. QUICKSTART.md로 더 자세한 가이드 확인
61+
3. examples/ 폴더에서 다양한 스타일 참고
62+
63+
### 개발자를 위해:
64+
1. 변경사항 확인 및 테스트
65+
2. 필요시 추가 예제 작성
66+
3. 문서 업데이트 및 개선
67+
68+
## 🎯 목표 달성
69+
70+
✅ 초보자도 쉽게 사용 가능
71+
✅ 5분 안에 시작 가능
72+
✅ 무료 호스팅 (GitHub Pages)
73+
✅ 반응형 디자인
74+
✅ 커스터마이징 가능
75+
✅ 예제 제공
76+
77+
---
78+
79+
## 🚀 다음은?
80+
81+
이제 이 템플릿으로 누구나 쉽게 멋진 자기소개 페이지를 만들 수 있습니다!
82+
83+
**README.md**를 읽고 바로 시작해보세요! 🎉

‎CONTRIBUTING.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# 🤝 기여 가이드
2+
3+
이 프로젝트에 기여해주셔서 감사합니다!
4+
5+
## 기여 방법
6+
7+
### 🐛 버그 제보
8+
9+
버그를 발견하셨나요?
10+
1. [Issues](../../issues)에서 동일한 문제가 보고되었는지 확인
11+
2. 새 Issue를 생성하고 다음을 포함:
12+
- 버그 설명
13+
- 재현 단계
14+
- 예상 동작과 실제 동작
15+
- 스크린샷 (가능한 경우)
16+
17+
### 💡 새 기능 제안
18+
19+
새로운 기능이나 개선 사항을 제안하고 싶으신가요?
20+
1. [Issues](../../issues)에서 제안을 공유
21+
2. 기능의 목적과 사용 사례 설명
22+
23+
### 🔧 코드 기여
24+
25+
1. 이 저장소를 Fork
26+
2. 새 브랜치 생성 (`git checkout -b feature/amazing-feature`)
27+
3. 변경 사항 커밋 (`git commit -m 'feat: Add amazing feature'`)
28+
4. 브랜치에 Push (`git push origin feature/amazing-feature`)
29+
5. Pull Request 생성
30+
31+
## 코딩 스타일
32+
33+
- 간결하고 읽기 쉬운 코드 작성
34+
- 주석은 한국어로 작성
35+
- 초보자도 이해할 수 있게 작성
36+
37+
## 커밋 메시지 규칙
38+
39+
- `feat:` - 새로운 기능
40+
- `fix:` - 버그 수정
41+
- `docs:` - 문서 변경
42+
- `style:` - 코드 스타일 변경 (포맷팅, 세미콜론 등)
43+
- `refactor:` - 코드 리팩토링
44+
- `chore:` - 기타 변경사항
45+
46+
## 라이센스
47+
48+
기여하신 코드는 이 프로젝트의 MIT 라이센스를 따릅니다.

0 commit comments

Comments
 (0)