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