From 27705b70b62b4899106df7bd217ea1b0f0d25aa2 Mon Sep 17 00:00:00 2001
From: soyoonjeong <76814748+soyoonjeong@users.noreply.github.com>
Date: Thu, 15 Feb 2024 20:45:30 +0900
Subject: [PATCH] Feat : git setting - #1

---
 .github/ISSUE_TEMPLATE.md        |  21 ++++
 .github/PULL_REQUEST_TEMPLATE.md |  15 +++
 .gitignore                       | 160 +++++++++++++++++++++++++++++++
 .gitmessage.txt                  |  26 +++++
 .pre-commit-config.yaml          |  14 +++
 gitsetting.sh                    |  18 ++++
 6 files changed, 254 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE.md
 create mode 100644 .gitignore
 create mode 100644 .gitmessage.txt
 create mode 100644 .pre-commit-config.yaml
 create mode 100644 gitsetting.sh

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 0000000..1b7a572
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,21 @@
+⭐ Description
+---
+-
+
+📷 Screenshots
+---
+-
+
+📁 Files
+---
+-
+
+📈 To Reproduce
+---
+-
+
+✔️ Tasks
+---
+- [ ] Task 1
+- [ ] Task 2
+- [ ] Task 3
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..86bd0ab
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,15 @@
+📌 개요
+---
+-
+
+💻 작업사항
+---
+-
+
+✅ 변경로직
+---
+-
+
+💡Issue 번호
+---
+-
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..68bc17f
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
diff --git a/.gitmessage.txt b/.gitmessage.txt
new file mode 100644
index 0000000..4c4db38
--- /dev/null
+++ b/.gitmessage.txt
@@ -0,0 +1,26 @@
+################
+# <타입> : <제목> 의 형식으로 제목을 아래 공백줄에 작성
+# 타입의 첫 문자는 대문자 / 제목은 50자 이내 / 변경사항이 "무엇"인지 명확히 작성 / 끝에 마침표 금지
+# 예) Feat : Add login
+
+# 바로 아래 공백은 지우지 마세요 (제목과 본문의 분리를 위함)
+
+################
+# 본문(구체적인 내용)을 아랫줄에 작성
+# 여러 줄의 메시지를 작성할 땐 "-"로 구분 (한 줄은 72자 이내)
+- 
+################
+# 꼬릿말(footer)을 아랫줄에 작성 (현재 커밋과 관련된 이슈 번호 추가 등)
+# 예) #7
+- 
+################
+# Feat : 새로운 기능 추가
+# Fix : 버그 수정
+# Docs : 문서 수정
+# Test : 테스트 코드 추가
+# Refactor : 코드 리팩토링
+# Style : 코드 의미에 영향을 주지 않는 변경사항
+# Chore : 빌드 부분 혹은 패키지 매니저 수정사항
+# Rename : 파일 혹은 폴더명을 수정하거나 옮기는 작업
+# Remove : 파일을 삭제하는 작업
+################
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
new file mode 100644
index 0000000..c5ee8d3
--- /dev/null
+++ b/.pre-commit-config.yaml
@@ -0,0 +1,14 @@
+# 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: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+-   repo: https://github.com/psf/black
+    rev: stable
+    hooks:
+    - id: black
+      language_version: python3.10
diff --git a/gitsetting.sh b/gitsetting.sh
new file mode 100644
index 0000000..9a74183
--- /dev/null
+++ b/gitsetting.sh
@@ -0,0 +1,18 @@
+# apply black to pre-commit
+pip install pre-commit
+pre-commit sample-config > .pre-commit-config.yaml
+cp pre-commit-config-template.yaml .pre-commit-config.yaml
+
+# commit message template
+git config --global commit.template .gitmessage.txt
+
+# issue & pr template
+mkdir .github
+cp ISSUE_TEMPLATE.md .github/ISSUE_TEMPLATE.md
+cp PULL_REQUEST_TEMPLATE.md .github/PULL_REQUEST_TEMPLATE.md
+
+# remove files
+rm ISSUE_TEMPLATE.md
+rm PULL_REQUEST_TEMPLATE.md
+rm pre-commit-config-template.yaml
+rm gitsetting.tar
\ No newline at end of file