summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJason Lee <changjin9792@gmail.com>2023-03-23 17:35:14 +0800
committerJason Lee <changjin9792@gmail.com>2023-03-23 17:35:14 +0800
commit6ae66af763c2afdd0a51c14a93fa8958bf98e353 (patch)
tree70d792dd3721affa947f93fcbc0392ec67a0c61e
parent2e3d7e0c3ea5f790eec14d111538e244e779cf91 (diff)
github config folder and gitignore file
-rwxr-xr-x.github/.gitmessage.txt23
-rwxr-xr-x.github/.pre-commit-config.yaml18
-rwxr-xr-x.github/ISSUE_TEMPLATE/README.md18
-rwxr-xr-x.github/ISSUE_TEMPLATE/bug-report.md15
-rw-r--r--.github/ISSUE_TEMPLATE/docs.md9
-rwxr-xr-x.github/ISSUE_TEMPLATE/extra.md11
-rwxr-xr-x.github/ISSUE_TEMPLATE/feature-request.md13
-rw-r--r--.github/ISSUE_TEMPLATE/refactor.md9
-rwxr-xr-x.github/commit_template_manual.md27
-rwxr-xr-x.github/pull_request_template.md29
-rw-r--r--.gitignore36
11 files changed, 208 insertions, 0 deletions
diff --git a/.github/.gitmessage.txt b/.github/.gitmessage.txt
new file mode 100755
index 0000000..9b99323
--- /dev/null
+++ b/.github/.gitmessage.txt
@@ -0,0 +1,23 @@
+################
+# Format: [Type] <Title>
+# Within 50 characters / Clearly indicate the changes / No period at the end
+# ex) [Feat] Add R-CNN Model
+# Write below
+
+# Do not delete the line below
+
+################
+# Write detailed description below
+# Use "-" for multiple lines (72 characters per line)
+
+################
+# Write footer below (issue number related to the current commit)
+# ex) issue #7
+
+################
+# Feat : New Feature
+# Fix : Bug Fix
+# Docs : Modify docs
+# Refact : Refactoring
+# Style : Changes that do not affect code logic
+################
diff --git a/.github/.pre-commit-config.yaml b/.github/.pre-commit-config.yaml
new file mode 100755
index 0000000..dcdb3d5
--- /dev/null
+++ b/.github/.pre-commit-config.yaml
@@ -0,0 +1,18 @@
+# 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: check-yaml
+ - id: check-json
+- repo: https://github.com/psf/black
+ rev: stable
+ hooks:
+ - id: black
+ language_version: python3.8
+- repo: https://gitlab.com/pycqa/flake8
+ rev: 4.0.1
+ hooks:
+ - id: flake8 \ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/README.md b/.github/ISSUE_TEMPLATE/README.md
new file mode 100755
index 0000000..5cb1e9d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/README.md
@@ -0,0 +1,18 @@
+## Template Description
+
+ 1. Bug Report (BUG)
+ * To fix bugs during development
+
+ 2. Feature Request (Feat)
+ * Request new features
+
+ 3. Extra (EXT)
+ * Extra
+
+## Rules
+
+ 1. Common
+ * Title
+ * ex) [Feat] Develop user registration APIs
+ * Label
+ * Choose label according to the template
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
new file mode 100755
index 0000000..5cde92e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -0,0 +1,15 @@
+---
+name: Bug Report
+about: Bug Report Template
+title: ""
+labels: ""
+assignees: ""
+---
+
+## Bug Description
+
+## Bug Simulation
+
+## Error Message
+
+## Screenshots
diff --git a/.github/ISSUE_TEMPLATE/docs.md b/.github/ISSUE_TEMPLATE/docs.md
new file mode 100644
index 0000000..8801215
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/docs.md
@@ -0,0 +1,9 @@
+---
+name: Docs
+about: Documentation
+title: ""
+labels: ""
+assignees: ""
+---
+
+## Description
diff --git a/.github/ISSUE_TEMPLATE/extra.md b/.github/ISSUE_TEMPLATE/extra.md
new file mode 100755
index 0000000..3ee87a4
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/extra.md
@@ -0,0 +1,11 @@
+---
+name: Extra
+about: Extra
+title: ""
+labels: ""
+assignees: ""
+---
+
+## Description
+
+## Comments
diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md
new file mode 100755
index 0000000..8dbadab
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature-request.md
@@ -0,0 +1,13 @@
+---
+name: Feature Request
+about: Template for requesting new features
+title: ""
+labels: ""
+assignees: ""
+---
+
+## Description
+
+## Purpose
+
+## Comments
diff --git a/.github/ISSUE_TEMPLATE/refactor.md b/.github/ISSUE_TEMPLATE/refactor.md
new file mode 100644
index 0000000..4805248
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/refactor.md
@@ -0,0 +1,9 @@
+---
+name: Refactor
+about: Refactor
+title: ""
+labels: ""
+assignees: ""
+---
+
+## Description
diff --git a/.github/commit_template_manual.md b/.github/commit_template_manual.md
new file mode 100755
index 0000000..15f89fe
--- /dev/null
+++ b/.github/commit_template_manual.md
@@ -0,0 +1,27 @@
+# Apply Commit Template Message
+
+Do `git clone` and you will see .gitmessage.txt
+
+๊ทธ ํ›„,<br>
+Do `git config --local commit.template .github/.gitmessage.txt`<br>
+to set the commit template.
+
+Now,<br>
+Do `git commit` when you commit instead of `git commit -m "message"`<br>
+
+After completing your commit, just close the commit file or<br>
+
+**โœ‹ For Linux bash or VSCode,**
+
+Type `Ctrl + x`<br>
+then you'll see save message, and type `y` to save it.
+
+If you type Enter, then commit is complete!
+
+**โœ‹ For git bash**
+
+Just do `:wq`
+
+<br>
+
+Then `git push`
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100755
index 0000000..ce3733e
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,29 @@
+## PR Description
+
+-
+
+<br>
+
+## Image (Optional)
+
+-
+
+<br>
+
+## Key Changes
+
+-
+
+<br>
+
+## Related Issue
+
+-
+
+<br>
+
+## To Reviewers
+
+-
+
+<br>
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..f1190bc
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,36 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+.env
+**/__pycache__
+**/__pycache__/**
+# dependencies
+/node_modules/
+**/node_modules/
+/.pnp
+.pnp.js
+
+**/__pycache__
+**/.env
+/venv/
+**/venv/
+.idea/
+venv/
+.backend_venv/
+.cli_venv/
+.venv/
+**/.venv/
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*