CONTRIBUTING.md

teamkw/Pangbot-Web-Extension에 기여하기

안녕하세요! PangBot-Web-Extension은 TeamKW가 만들고 관리하는 프로젝트입니다.

이 문서는 여러분이 이 프로젝트에 기여하기 위해 알아햐 할 정보와 절차를 제공합니다.

여러분의 기여를 언제나 환영합니다! 많은 관심 부탁드려요!

TeamKW란?

광운대학교 학생들로 이루어진 오픈소스 그룹입니다. 가입 절차 없이 프로젝트에 기여하거나 커뮤니티에서 활동하면 누구나 TeamKW의 일원입니다.

목적

TeamKW는 아래와 같은 학생분들께 의미있는 프로그래밍 경험을 제공하고자 합니다 :

• 💻 실제로 다른 사람들이 사용하는 프로젝트에 참여하며 실력을 쌓아가고 싶은 분들
• 🤗 다른 사람들과 함께 프로그래밍을 하고 싶은데 적절한 기회가 없었던 분들
• 🤔 오픈소스에 기여해보고 싶은데 처음이라 어떻게 할 지 모르겠는 분들
• 🙌 도움을 주고받으며 함께 성장하는 동기들을 만들고 싶은 분들
• 😎 프로그래밍이 너무 재미있어 어쩔 줄 모르겠는 분들
• 개발자가 아니더라도 디자인, 프로젝트 운영 등 다양한 분야의 경험을 얻고 싶은 분들

참여하기

기여하시기 전에 먼저 커뮤니티에서 다른 TeamKW 참여자들과 소통해주시길 바랍니다.

TeamKW 디스코드 링크 : https://discord.gg/UDqCW79RVN

이 곳에서 다음과 같은 활동을 하실 수 있습니다 :

• 프로젝트 참여자들간의 소통
• 전체 TeamKW 멤버들과 소통
• 자유로운 질문, 도움 요청
• 새로운 프로젝트 아이디어 제시
• 그 외 '소통'에 관련된 모든 것

깃허브에서 실시간으로 소통하는 것이 어려울 수 있습니다. 그럴 때 디스코드에서 빠르게 피드백을 얻고, 다양한 대화를 주고 받을 수 있습니다.

소프트웨어를 전공하지 않은 분들도 모두 환영합니다. 부담 갖지 말고 들어오세요!

🦄PangBot이란?

TeamKW에서 관리하는 🏫광운대학교 관련 프로젝트입니다. 예를 들어 현재 진행중인 KLAS 사이트 크롬 익스텐션과 카카오톡 챗봇이 있습니다.

PangBot은 학생들에게 다양한 편의 기능을 제공하기 위해 시작된 프로젝트입니다.

입학하기 전 고등학생부터 졸업 후 취직한 분들까지 모두 이용하는 기능을 제공하는 것이 PangBot의 목표입니다.

🤔 (처음으로) 기여하는 방법

Issue 페이지를 보시면 '🐣적절한 첫 이슈' 레이블이 붙은 이슈를 보실 수 있습니다. 그 중 마음에 드는 것을 고른 후, TeamKW 디스코드 채널이나 Issue 안의 댓글을 통해 다른 분들과 소통을 해주시길 바랍니다. 누구에게 말을 걸어야할지 잘 모르시겠다면 @pkeugine 을 태그해 주시면 TeamKW 관리자와 대화를 나누실 수 있습니다.

💻 익스텐션 개발 방법

만약 GitHub에 익숙하지 않으신 분이라면 TeamKW 디스코드 서버의 해당 프로젝트 채널에서 도움을 요청해주세요.

GitHub에 익숙하신 분이라면 다음과 같은 절차를 따라주세요 :

1. 해당 repository를 fork 한다.
2. fork한 repository를 본인 컴퓨터에 clone한다.
3. Chrome을 열고 웹 주소를 적는 칸에 chrome://extensions 를 입력하고 엔터를 누른다.
4. 좌측 상단에 Load Unpacked 버튼을 누른 후, clone한 코드의 디렉토리를 선택한다.
5. KLAS 홈페이지에 들어간 후, 익스텐션이 잘 돌아가는지 확인한다.
6. 각자 원하는 개발 툴로 익스텐션을 발전시킨다.
7. 익스텐션 만드는 자세한 설명은 https://developer.chrome.com/extensions/getstarted 를 확인한다.
8. 본인이 구현한 기능이 작동되는지 확인하려면 chrome://extensions 에서 익스텐션을 refresh 한 뒤 확인해본다.
9. 기능이 하나씩 추가될 때마다 git push와 commit을 한다.
10. pull request를 하기 전에 teamkw/PangBot-Web-Extension 이 업데이트 되었다면 본인의 repository를 rebase 한다.
11. pull request를 한다.
12. 여러분도 이제 코드로 PangBot에 기여하셨습니다!