bandi120424 / charting

charting

charting's Issues

[FEAT] streamlit 화면 구성

Background

• 사용자로부터 요약할 텍스트를 받아 요약 결과를 출력하는 화면을 만든다

To Do

• 요약할 텍스트를 받는 부분
• 결과를 출력하는 부분

[RULE] Convention

Commit

Header

• Commit Log의 제목을 나타냅니다.
  • Add: 새로운 파일 추가
  • Feat: 새로운 기능 추가
  • Fix: 버그 수정
  • Docs: 문서 수정
  • Style: 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
  • Refactor: 코드 리펙토링
  • Test: 테스트 코드, 리펙토링 테스트 코드 추가
  • Chore: 빌드 업무 수정, 패키지 매니저 수정

Body

• 작업에 대한 상세 기록을 나타냅니다.
• 모두 소문자로 작성합니다.

Footer

• Footer에는 해당 작업과 관련된 Issue의 Tag가 붙습니다.
  • Issue 기반으로 작업을 하는 것이 좋습니다.
• Commit Log에 Issue Tag를 남기면 Github에서 자동으로 해당 태그를 인식하여 Issue에 관련된 Commit을 연결해줍니다.

"Add: 커밋 메시지

#1 "

Issue

• Issue는 ‘개발 작업 단위’라고 생각하면 편합니다.

• 작업의 History를 관리하기 위해 작성하는 것이 좋습니다.

  • 모두 대문자로 작성합니다.
  • [FEAT] / [BUG] / [REFACTOR]

• Issue Template 설명

  • Background: 해당 이슈에 대한 설명
  • To Do: 구현하려는 내용
    • 작업항목 1
      • 디테일 1
      • 디테일 2
  • See Also: Tag입력

PR Convention

• Issue와 비슷하게, PR에서는 작업한 내용의 대략적인 내용(Overview), 변경된 부분(Change Log),
  리뷰어가 참고해야할 사항(To Reviewer), 관련된 이슈 (Issue Tag)를 기록합니다.
• Reviewer, Assignee를 반드시 지정하고, 가능하다면 작업의 Label도 부착합니다.
• Commit Convention과 동일하게 작성합니다.

[FEAT] openai를 이용하여 텍스트 요약 결과 받아오기

Background

• openai의 API를 이용, 사용자가 입력한 텍스트를 요약본을 생성한다.

To Do

• 사용자가 입력한 결과를 받아 지시사항에 따라 요약 결과를 반환하는 기능