From d85368264ed2b9b81d75479377838f47965c6b80 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EB=B0=B1=EA=B4=91=ED=98=84=5FT6074?= Date: Thu, 29 Feb 2024 19:15:44 +0900 Subject: [PATCH] git init - Add Template - Add linting --- .github/ISSUE_TEMPLATE/bug_report.md | 19 +++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 14 ++++++ .github/PULL_REQUEST_TEMPLATE.md | 12 ++++++ .gitmessage | 24 +++++++++++ .pre-commit-config.yaml | 52 +++++++++++++++++++++++ 5 files changed, 121 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .gitmessage create mode 100644 .pre-commit-config.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..f8ec71a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,19 @@ +--- +name: Bug Report +about: 버그를 레포트 할 때 사용하는 템플릿 +title: "[BUG] " +labels: '' +assignees: '' + +--- + +## Describe the bug +- + +## To Reproduce +- + +## Expected Behavior +- + +## Screenshots (Optional) \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..2643aaa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,14 @@ +--- +name: Feature Request +about: 새로운 기능을 추가할 때 사용하는 템플릿 +title: "[FEAT] " +labels: '' +assignees: '' + +--- + +## Background +- + +## To Do +- [ ] \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..c8f0cae --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,12 @@ +## Overview +- + +## Change Log +- + +## To Reviewer +- + +## Issue Tags +- closed: # +- sell also: # (optional) diff --git a/.gitmessage b/.gitmessage new file mode 100644 index 0000000..c10e929 --- /dev/null +++ b/.gitmessage @@ -0,0 +1,24 @@ +################ +# <타입> : <제목> 의 형식으로 제목을 아래 공백줄에 작성 +# 제목은 50자 이내 / 변경사항이 "무엇"인지 명확히 작성 / 끝에 마침표 금지 +# 예) feat : 로그인 기능 추가 + +# 바로 아래 공백은 지우지 마세요 (제목과 본문의 분리를 위함) + +################ +# 본문(구체적인 내용)을 아랫줄에 작성 +# 여러 줄의 메시지를 작성할 땐 "-"로 구분 (한 줄은 72자 이내) + +################ +# 꼬릿말(footer)을 아랫줄에 작성 (현재 커밋과 관련된 이슈 번호 추가 등) +# 예) Close #7 + +################ +# feat : 새로운 기능 추가 +# fix : 버그 수정 +# docs : 문서 수정 +# test : 테스트 코드 추가 +# refact : 코드 리팩토링 +# style : 코드 의미에 영향을 주지 않는 변경사항 +# chore : 빌드 부분 혹은 패키지 매니저 수정사항 +################ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..6c7e06b --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,52 @@ +# See https://pre-commit.com for more information +# See https://pre-commit.com/hooks.html for more hooks +repos: +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.5.0 + hooks: + - id: trailing-whitespace + - id: end-of-file-fixer + - id: check-yaml + - id: check-added-large-files +- repo: https://github.com/pycqa/flake8 + rev: 7.0.0 + hooks: + - id: flake8 +- repo: https://github.com/myint/autoflake + rev: v2.2.1 + hooks: + - id: autoflake + args: ["--in-place", "--remove-all-unused-imports", "--remove-unused-variables", "--expand-star-imports", "--ignore-init-module-imports"] + files: \.py$ + exclude: | + (?x)( + ^.git/| + ^output/| + ^plugins + ) +- repo: https://github.com/pycqa/isort + rev: '5.13.2' + hooks: + - id: isort + language: python + args: ["--filter-files"] + files: \.py$ +- repo: https://github.com/psf/black + rev: '24.2.0' + hooks: + - id: black + args: ["--line-length=120"] + exclude: | + (?x)( + ^.git/| + ^output/| + ^plugins| + ^plugins| + ) +exclude: | + (?x)( + ^.git/| + ^output/| + ^plugins| + ^plugins| + ) \ No newline at end of file