paperspoon / better-comment

Better Comment

Better Comment는 GitHub에서 코멘트를 작성할 때, 해당 코멘트가 공격적이지 않고, 받는 사람의 기분을 상하지 않는지 분석해주는 크롬 확장 프로그램입니다. OpenAI의 API를 사용하여 코멘트를 분석하고, 개선된 문구를 제안합니다.

설치 방법

1. 이 저장소를 로컬 컴퓨터로 클론합니다.

   git clone https://github.com/paperspoon/better-comment.git

2. 크롬 브라우저에서 chrome://extensions/로 이동합니다.

3. 오른쪽 상단의 "개발자 모드" 토글을 활성화합니다.

4. 왼쪽 상단의 "압축 해제된 확장 프로그램을 로드합니다." 버튼을 클릭하고, 클론한 저장소의 디렉토리를 선택합니다.

사용 방법

1. 확장 프로그램이 설치되면, 크롬 확장 프로그램 아이콘 영역에 새로운 아이콘을 확인할 수 있습니다.

2. GitHub 페이지에서 코멘트를 작성하는 텍스트 영역에 입력한 후 폼에서 포커스가 떠나면 (onBlur), 코멘트가 분석되어 개선된 문구가 표시됩니다.

설정

1. OpenAI API 키를 사용하려면, 아래 주소에서 API 키를 발급받으세요. https://platform.openai.com/

2. 확장 프로그램 아이콘을 클릭하여 팝업창에서 API키를 입력한후 Save 버튼을 클릭합니다.

3. 필요에 따라 프롬프트를 바꾸거나 기타 옵션을 수정하실 수 있습니다.

TODO

• 코드를 포함해서 프롬프트를 작성할 수 있는 옵션 제공 (토큰 소모가 많을듯?)

기여

프로젝트에 기여하려면, 이 저장소를 포크한 후에 변경 사항을 커밋하고 풀 리퀘스트를 생성해주세요. 풀 리퀘스트가 검토된 후 프로젝트에 기여한 내용이 추가될 수 있습니다.

라이센스

이 프로젝트는 MIT 라이센스를 따릅니다.