Feedback

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+issue_templates:
+  - name: Experiment Template
+    description: For new experiments
+    file: experiment.md
+  - name: Feature Template
+    description: For new features
+    file: feature.md

.github/ISSUE_TEMPLATE/experiment.md

@@ -0,0 +1,26 @@
+---
+name: Experiment Issue
+about: Suggest a new experiment for this project
+title: "[EXP]"
+labels: 
+assignees: ''
+---
+
+# ISSUE: Experiment
+
+## 노션 링크
+
+
+## 실험 목적
+
+- 목적 1
+- 목적 2
+
+## 체크리스트
+
+- [ ]  할일 1
+- [ ]  할일 2
+- [ ]  할일 3
+
+## 실험 내용
+

.github/ISSUE_TEMPLATE/feature.md

@@ -0,0 +1,26 @@
+---
+name: Feature Issue
+about: Suggest a new feature for this project
+title: "[FEAT]"
+labels: 
+assignees: ''
+---
+
+# ISSUE: Feature
+
+## 노션 링크
+
+
+## 기능 목적
+
+- 목적 1
+- 목적 2
+
+## 체크리스트
+
+- [ ]  할일 1
+- [ ]  할일 2
+- [ ]  할일 3
+
+## 기능 내용
+

.github/pull_request_template.md

@@ -0,0 +1,13 @@
+## PR 정보
+
+- 목적: 
+- 이슈 번호: 
+- 노션 작업 카드 링크:
+
+## 변경 사항
+
+- 이번 PR에서 작업한 내용을 간략히 설명
+
+## 리뷰 참고사항
+
+- 리뷰어에게 필요한 설명이나 특별히 봐주었으면 하는 부분을 작성

.github/workflows/check-lint.yml

@@ -0,0 +1,24 @@
+name: check-lint
+
+on: [pull_request]
+
+jobs:
+  check-lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+
+      - name: Check Lint
+        run: |
+          make quality

.gitignore

@@ -0,0 +1,31 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.idea/
+# macOS
+*DS_Store
+
+# custom
+tmp/
+data/
+output/
+outputs/
+**/wandb/
+config/config.yaml
+config/credentials.json
+config/token.json
+nohup.out
+preprocess/results/
+preprocess_minseo/1.BERT-based-relabeling/results/
+preprocess_minseo/1.BERT-based-relabeling/checkpoint/
+preprocess_minseo/1.BERT-based-relabeling/wandb/

.pre-commit-config.yaml

@@ -0,0 +1,8 @@
+repos:
+-   repo: local
+    hooks:
+    - id: style
+      name: style
+      language: system
+      entry: make style
+      types: [python]

Makefile

@@ -0,0 +1,48 @@
+clean: clean-pyc clean-test
+quality: set-style-dep check-quality
+style: set-style-dep set-style
+setup: set-precommit set-style-dep set-test-dep set-git set-dev
+test: set-test-dep set-test
+
+
+##### basic #####
+set-git:
+	git config --local commit.template .gitmessage
+
+set-style-dep:
+	pip3 install ruff==0.7.2
+
+set-test-dep:
+	pip3 install pytest==8.3.2
+
+set-precommit:
+	pip3 install pre-commit==4.0.1
+	pre-commit install
+
+set-dev:
+	pip3 install -r ./setup/requirements.txt
+
+set-test:
+	python3 -m pytest tests/
+
+set-style:
+	ruff check --fix .
+	ruff format .
+
+check-quality:
+	ruff check .
+	ruff format --check .
+
+#####  clean  #####
+clean-pyc:
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+	find . -name '__pycache__' -exec rm -fr {} +
+
+clean-test:
+	rm -f .coverage
+	rm -f .coverage.*
+	rm -rf .pytest_cache
+	rm -rf .mypy_cache
+	rm -rf .ruff_cache