diff --git a/.coderabbit.yaml b/.coderabbit.yaml new file mode 100644 index 0000000..edd85df --- /dev/null +++ b/.coderabbit.yaml @@ -0,0 +1,83 @@ +language: ko-KR + +early_access: true +enable_free_tier: true + +reviews: + profile: chill + request_changes_workflow: false + high_level_summary: true + high_level_summary_placeholder: '코드토깽이의 요약' + auto_title_placeholder: '@코드토깽이' + poem: false + review_status: true + collapse_walkthrough: false + + abort_on_close: true + + auto_review: + enabled: true + auto_incremental_review: true + ignore_title_keywords: [] + labels: [] + drafts: false + base_branches: [] + + tools: + shellcheck: + enabled: true + ruff: + enabled: true + markdownlint: + enabled: true + github-checks: + enabled: true + timeout_ms: 90000 + languagetool: + enabled: true + disabled_rules: + - EN_UNPAIRED_BRACKETS + - EN_UNPAIRED_QUOTES + disabled_categories: + - TYPOS + - TYPOGRAPHY + - CASING + enabled_only: false + level: default + enabled_rules: [] + enabled_categories: [] + biome: + enabled: true + hadolint: + enabled: true + swiftlint: + enabled: true + phpstan: + enabled: true + level: default + golangci-lint: + enabled: true + yamllint: + enabled: true + gitleaks: + enabled: true + checkov: + enabled: true + ast-grep: + packages: [] + rule_dirs: [] + util_dirs: [] + essential_rules: true + +chat: + auto_reply: true + +knowledge_base: + web_search: + enabled: true + learnings: + scope: auto + issues: + scope: auto + jira: + project_keys: [] diff --git a/.github/ISSUE_TEMPLATE/Bug-Report.yml b/.github/ISSUE_TEMPLATE/Bug-Report.yml new file mode 100644 index 0000000..7bd5dd0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug-Report.yml @@ -0,0 +1,33 @@ +name: Bug Report +description: 버그 수정용 이슈 템플릿입니다. +title: "[bug] " +labels: ["🐞 bug"] +body: + - type: input + id: description + attributes: + label: "🐞 버그 설명" + description: "어떤 버그인지 명확히 작성해주세요" + validations: + required: true + + - type: textarea + id: tasks + attributes: + label: "🔧 수정할 작업 목록" + description: "수정해야 할 항목들을 체크리스트로 작성해주세요" + value: | + - [ ] 버그 재현 + - [ ] 원인 분석 + - [ ] 수정 및 테스트 + validations: + required: true + + - type: input + id: links + attributes: + label: "🔗 참고 링크" + description: "관련 문서, 스크린샷, 로그 등이 있다면 첨부해주세요 (선택)" + placeholder: "https://..." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/Issue.md b/.github/ISSUE_TEMPLATE/Issue.md deleted file mode 100644 index ef60fd5..0000000 --- a/.github/ISSUE_TEMPLATE/Issue.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: "\bIssue Templete" -about: default issue template -title: '' -labels: '' -assignees: '' - ---- - - - -## 💡 Issue - - -## 🔥 Tasks - - -## 🎨 스크린샷(선택) - -|기능|스크린샷| -|:--:|:--:| -|GIF|| diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..72f5fc4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,27 @@ +blank_issues_enabled: false +contact_links: [] + +issue_templates: + - name: ✨ feature + description: 새로운 기능 개발을 위한 이슈 + file: feature-task.yml + + - name: 🐞 bug + description: 버그 수정 작업을 위한 이슈 + file: Bug-Report.yml + + - name: 🔨 refactor + description: 코드 리팩토링 작업 이슈 + file: refactor-task.yml + + - name: 📃 docs + description: 문서 작성 및 수정 작업 이슈 + file: docs-task.yml + + - name: ⚙️ chore + description: 개발 환경 설정 관련 이슈 + file: setting-task.yml + + - name: ✅ test + description: 테스트 코드 작성 및 테스트 환경 구축 + file: test-task.yml diff --git a/.github/ISSUE_TEMPLATE/docs-task.yml b/.github/ISSUE_TEMPLATE/docs-task.yml new file mode 100644 index 0000000..b19b5c4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs-task.yml @@ -0,0 +1,32 @@ +name: Docs Task +description: 문서 작성 및 수정을 위한 템플릿입니다. +title: "[docs] " +labels: ["📃 docs"] +body: + - type: input + id: description + attributes: + label: "📘 문서 설명" + description: "작성/수정할 문서의 내용을 설명해주세요" + validations: + required: true + + - type: textarea + id: tasks + attributes: + label: "📝 문서 작업 목록" + description: "진행할 문서 작업들을 작성해주세요" + value: | + - [ ] 문서 초안 작성 + - [ ] 코드 예시 추가 + validations: + required: true + + - type: input + id: links + attributes: + label: "🔗 참고 링크" + description: "기존 문서, 규칙, 외부 링크 등이 있다면 첨부해주세요 (선택)" + placeholder: "https://..." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature-task.yml b/.github/ISSUE_TEMPLATE/feature-task.yml new file mode 100644 index 0000000..0eec996 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-task.yml @@ -0,0 +1,32 @@ +name: Feature Task +description: 새로운 기능을 개발할 때 사용하는 템플릿입니다. +title: "[feature] " +labels: ["✨ feature"] +body: + - type: input + id: description + attributes: + label: "📝 기능 설명" + description: "개발할 기능에 대해 간단히 설명해주세요" + validations: + required: true + + - type: textarea + id: tasks + attributes: + label: "✅ 작업 목록" + description: "수행할 작업을 체크리스트 형식으로 작성해주세요" + value: | + - [ ] Task1 + - [ ] Task2 + validations: + required: true + + - type: input + id: links + attributes: + label: "🔗 참고 링크" + description: "관련 문서, 디자인 링크 등이 있다면 첨부해주세요 (선택)" + placeholder: "https://..." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/refactor-task.yml b/.github/ISSUE_TEMPLATE/refactor-task.yml new file mode 100644 index 0000000..f27ddf0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/refactor-task.yml @@ -0,0 +1,32 @@ +name: Refactor Task +description: 리팩토링 작업을 위한 템플릿입니다. +title: "[refactor] " +labels: ["🔨 refactor"] +body: + - type: input + id: description + attributes: + label: "♻️ 리팩토링 설명" + description: "리팩토링 대상 및 이유를 설명해주세요" + validations: + required: true + + - type: textarea + id: tasks + attributes: + label: "🧹 리팩토링 작업 목록" + description: "진행할 리팩토링 작업들을 작성해주세요" + value: | + - [ ] 불필요한 코드 제거 + - [ ] 성능 개선 + validations: + required: true + + - type: input + id: links + attributes: + label: "🔗 참고 링크" + description: "관련 문서, 레퍼런스 코드 등이 있다면 첨부해주세요 (선택)" + placeholder: "https://..." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/setting-task.yml b/.github/ISSUE_TEMPLATE/setting-task.yml new file mode 100644 index 0000000..0e8ce75 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/setting-task.yml @@ -0,0 +1,32 @@ +name: Setting Task +description: 개발 환경 설정 작업을 위한 템플릿입니다. +title: "[chore] " +labels: ["⚙️ chore"] +body: + - type: input + id: description + attributes: + label: "⚙ 설정 작업 설명" + description: "무엇을 설정/변경하는지 설명해주세요" + validations: + required: true + + - type: textarea + id: tasks + attributes: + label: "🔧 설정 작업 목록" + description: "진행할 설정 작업들을 작성해주세요" + value: | + - [ ] 환경 변수 설정 + - [ ] ESLint 설정 변경 + validations: + required: true + + - type: input + id: links + attributes: + label: "🔗 참고 링크" + description: "관련 설정 문서, 참고 링크 등이 있다면 첨부해주세요 (선택)" + placeholder: "https://..." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/test-task.yml b/.github/ISSUE_TEMPLATE/test-task.yml new file mode 100644 index 0000000..1e2bd63 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/test-task.yml @@ -0,0 +1,31 @@ +name: Test Task +description: 테스트 코드 작성 및 테스트 환경 구축을 위한 이슈입니다. +title: "[test] " +labels: ["✅ test"] +body: + - type: input + id: description + attributes: + label: "✅ 테스트 설명" + description: "어떤 테스트를 수행할지 설명해주세요" + validations: + required: true + + - type: textarea + id: tasks + attributes: + label: "🧪 테스트 작업 목록" + description: "진행할 테스트 항목을 정리해주세요" + value: | + - [ ] 레포지토리 생성 테스트 + validations: + required: true + + - type: input + id: links + attributes: + label: "🔗 참고 링크" + description: "테스트 가이드, 문서 링크 등이 있다면 첨부해주세요 (선택)" + placeholder: "https://..." + validations: + required: false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e890afb..00801c4 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,12 +1,17 @@ - + ## 💡 PR 유형 - -- [ ] Feature: 기능 추가 -- [ ] Hotfix: 작은 버그 수정 -- [ ] Bugfix: 큰 버그 수정 -- [ ] Refactor: 코드 개선 -- [ ] Chore: 환경 설정 + +- [ ] ✨ Feature (기능 추가) +- [ ] 🐞 Bugfix (버그 수정) +- [ ] 🔧 Refactor (코드 리팩토링) +- [ ] ⚙️ Chore (환경 설정) +- [ ] 📝 Docs (문서 작성 및 수정) +- [ ] ✅ Test (기능 테스트) ## ✏️ 변경 사항 @@ -18,13 +23,15 @@ ## 🧪 테스트 - [ ] 목표한 구현 정상 동작 확인 +- [ ] 엣지 케이스 테스트 완료 +- [ ] 기존 기능 영향 없음 ## 🎨 스크린샷 |기능|스크린샷| |:--:|:--:| -|GIF|| +|GIF|| ## ✅ 체크리스트 @@ -33,6 +40,6 @@ - [ ] 불필요한 코드가 없고, 정상적으로 동작하는지 확인했나요? - [ ] 관련 이슈 번호를 작성했나요? -## 🔥 추가 설명 +## 🔥 추가 설명 or 리뷰 포인트