Merge pull request #1 from boostcampaitech5/docs

[Docs] Create Base Documents

.github/ISSUE_TEMPLATE/BugReport.yml

@@ -0,0 +1,64 @@
+name: "\U0001F41B Bug Report"
+description: bug에 대해서 설명해주세요
+body:
+  - type: textarea
+    id: system-info
+    attributes:
+      label: System Info
+      description: system info를 먼저 공유해주세요.
+      placeholder: branch name, project version, python version
+    validations:
+      required: true
+
+  - type: textarea
+    id: who-can-help
+    attributes:
+      label: Who can help?
+      description: |
+        버그 코드를 맡거나 원하시는 팀원이 있다면 @로 태그를 걸어주세요.
+        
+      placeholder: "@Username ..."
+
+  # - type: checkboxes
+  #   id: information-scripts-examples
+  #   attributes:
+  #     label: Information
+  #     description: '쓸때 생긴 문제에 대해 체크해주세요.'
+  #     options:
+  #       - label: "The official example scripts"
+  #       - label: ""
+
+  # - type: checkboxes
+  #   id: information-tasks
+  #   attributes:
+  #     label: Tasks
+  #     description: "The tasks I am working on are:"
+  #     options:
+  #       - label: "An officially supported task in the `examples` folder (such as GLUE/SQuAD, ...)"
+  #       - label: "My own task or dataset (give details below)"
+
+  - type: textarea
+    id: reproduction
+    validations:
+      required: true
+    attributes:
+      label: Reproduction
+      description: |
+        버그가 있는 코드와 error message, stack traces 같은 것들을 올려주세요.
+        해당 링크에 들어가시면 스크린샷 대신에 코드를 복사하는 방법이 있습니다.
+        https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting
+
+      placeholder: |
+        문제 재현을 위한 step을 자세하게 설명해주세요.
+          1.
+          2.
+          3.
+          
+
+  - type: textarea
+    id: expected-behavior
+    validations:
+      required: true
+    attributes:
+      label: 예상 결과 및 원하는 결과
+      description: "예상결과나 원하는 결과를 명확하고 자세히 적어주세요."

.github/ISSUE_TEMPLATE/DataProposal.yml

@@ -0,0 +1,20 @@
+name: 데이터와 EDA
+description: 데이터에 대해서 자세히 서술해주세요!
+
+body:
+- type: textarea
+  attributes:
+    label: 현재 상황과 EDA
+    description: >
+      현재 상황과 EDA에 대해서 자세히 서술해주세요!
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: 개선 제안 사항
+    description: >
+      EDA를 바탕으로 개선 하기 위한 방법이 있다면 그것도 자세히 서술해주세요!
+- type: markdown
+  attributes:
+    value: >
+      수고하셨습니다!

.github/ISSUE_TEMPLATE/EtcProposal.yml

@@ -0,0 +1,25 @@
+name: 기타 변경 제안
+description: 기타 제안점에 대해서 자세히 서술해주세요!
+
+body:
+- type: textarea
+  attributes:
+    label: 현재 상황과 문제점
+    description: >
+      현재 상황과 문제점에 대해서 간략히 서술해주세요.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: 개선 제안 사항
+    description: >
+      개선 하기 위한 제안 사항에 대해서 자세히 서술해주세요! 왜 제안 하시는지도 자세히 서술해주세요! 참고하신 문서가 있다면, 링크도 같이 남겨주세요!
+- type: textarea
+  attributes:
+    label: 기대점
+    description: >
+      제안사항이 반영될 시, 개선될 것으로 예상되는 점을 서술해주세요!
+- type: markdown
+  attributes:
+    value: >
+      수고하셨습니다!

.github/ISSUE_TEMPLATE/FeatureProposal.yml

@@ -0,0 +1,21 @@
+name: "기능 추가"
+description: 프로젝트에 새로 추가하길 원하시는 내용을 제안 / 요청 해주세요. 
+labels: [ "feature" ]
+body:
+  - type: textarea
+    id: feature-request
+    validations:
+      required: true
+    attributes:
+      label: Feature request
+      description: |
+        기능 제안에 대한 명확하고 간결한 설명과 함께, 논문과 코드가 있는 경우 해당 링크를 제공해 주세요.
+
+  - type: textarea
+    id: motivation
+    validations:
+      required: true
+    attributes:
+      label: Motivation
+      description: |
+        제안의 동기를 간략하게 설명해 주세요. 연관된 Issue 혹은 PR이 있는 경우 함께 언급해주세요. 

.github/ISSUE_TEMPLATE/ModelProposal.yml

@@ -0,0 +1,27 @@
+name: 모델 변경 제안
+description: 모델 변경 제안점에 대해서 자세히 설명해주세요.
+
+body:
+- type: textarea
+  attributes:
+    label: 현재 상황과 문제점
+    description: >
+      현재 상황과 문제점에 대해서 간략히 서술해주세요. Metric 또는 성능! 
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: 개선 제안 사항
+    description: >
+      개선 하기 위한 모델 변경 제안 사항에 대해서 자세히 서술해주세요! 왜 제안 하시는지도 자세히 서술해주세요!
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: 성능 개선 기대점
+    description: >
+      모델 변경 시, 성능이 개선될 것으로 예상되는 점을 서술해주세요!
+- type: markdown
+  attributes:
+    value: >
+      수고하셨습니다!

.github/ISSUE_TEMPLATE/ParamsProposal.yml

@@ -0,0 +1,27 @@
+name: 파라미터 변경 제안
+description: 파라미터 변경 제안점에 대해서 자세히 설명해주세요. 파라미터 변경 제안사항에는 Optimizer, Scheduler 등을 포함합니다.
+
+body:
+- type: textarea
+  attributes:
+    label: 현재 상황과 문제점
+    description: >
+      현재 상황과 문제점에 대해서 간략히 서술해주세요. Metric 또는 성능! 
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: 개선 제안 사항
+    description: >
+      개선 하기 위한 파라미터 변경 제안 사항에 대해서 자세히 서술해주세요! 왜 제안 하시는지도 자세히 서술해주세요!
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: 성능 개선 기대점
+    description: >
+      파라미터 변경 시, 성능이 개선될 것으로 예상되는 점을 서술해주세요!
+- type: markdown
+  attributes:
+    value: >
+      수고하셨습니다!

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true