Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc/GitHub #51

Merged
merged 2 commits into from
Sep 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: 버그 리포트
about: 버그를 보고하여 개선에 도움을 주세요
title: '[버그] '
labels: 버그
assignees: ''

---

**버그 설명**
버그에 대한 명확하고 간결한 설명을 해주세요.

**재현 방법**
버그를 재현하는 단계:
1. '...'로 이동
2. '....'를 클릭
3. '....'까지 스크롤
4. 오류 확인

**예상 동작**
예상했던 동작에 대한 명확하고 간결한 설명을 해주세요.

**스크린샷**
해당되는 경우, 문제를 설명하는 데 도움이 되는 스크린샷을 추가해주세요.

**환경 (다음 정보를 작성해주세요):**
- OS: [예: iOS]
- 버전 [예: 22]

**추가 정보**
문제에 대한 다른 맥락이나 정보를 여기에 추가해주세요.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: 기능 제안
about: 이 프로젝트에 대한 아이디어를 제안해주세요
title: '[기능] '
labels: 개선
assignees: ''

---

**제안하는 기능이 어떤 문제와 관련이 있나요? 설명해주세요.**
문제에 대한 명확하고 간결한 설명을 해주세요. 예: 항상 [...] 때문에 불편합니다.

**원하는 해결책을 설명해주세요**
원하는 결과에 대한 명확하고 간결한 설명을 해주세요.

**고려한 대안을 설명해주세요**
고려했던 다른 대안이나 기능에 대해 설명해주세요.

**추가 정보**
기능 요청에 대한 다른 맥락이나 스크린샷을 여기에 추가해주세요.
27 changes: 27 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## 설명
이 PR에서 변경한 내용에 대해 간단히 설명해주세요.

## 관련 이슈
해결하는 이슈 번호를 적어주세요. 예: #123

## 변경 유형
- [ ] 버그 수정
- [ ] 새로운 기능
- [ ] 성능 개선
- [ ] 코드 스타일 업데이트 (포맷팅, 변수명 등)
- [ ] 리팩토링 (기능적 변경 없음, API 변경 없음)
- [ ] 빌드 관련 변경
- [ ] 문서 내용 변경
- [ ] 기타 (설명해주세요):

## 체크리스트:
- [ ] 내 코드가 프로젝트의 코드 스타일 가이드라인을 따릅니다
- [ ] 내가 내 코드를 자체 리뷰했습니다
- [ ] 내 변경사항으로 인해 새로운 경고가 발생하지 않습니다
- [ ] 단위 테스트를 추가했습니다
- [ ] 기존 단위 테스트가 모두 통과합니다
- [ ] 필요한 경우 해당 문서를 변경했습니다
- [ ] 내 변경사항에 대한 종속성 업데이트가 포함되어 있습니다

## 추가 정보
PR에 대한 추가 정보나 스크린샷을 여기에 추가하세요.
30 changes: 30 additions & 0 deletions .github/workflows/code-quality.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: 코드 품질 검사

on:
push:
branches: [ main, devel ]
pull_request:
branches: [ main, devel ]

jobs:
pre-commit:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Python 설정
uses: actions/setup-python@v3
with:
python-version: '3.10'
- name: pre-commit 캐시 설정
uses: actions/cache@v3
with:
path: ~/.cache/pre-commit
key: ${{ runner.os }}-pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
restore-keys: |
${{ runner.os }}-pre-commit-
- name: pre-commit 설치
run: |
python -m pip install --upgrade pip
pip install pre-commit
- name: pre-commit 실행
run: pre-commit run --all-files
Loading