CONTRIBUTING.md

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

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

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

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

TeamKW란?

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

목적

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

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

참여하기

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

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

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

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

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

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

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

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

📚 unibook 로컬 환경에서 실행 방법

만약 GitHub에 익숙하지 않거나 이 절차가 잘 이해되지 않는다면 TeamKW 디스코드 서버의 해당 프로젝트 채널에서 도움을 요청해주세.

1. 해당 repository를 fork 한다.
2. fork한 repository를 본인 컴퓨터에 clone한다.
3. 본인의 컴퓨터에 rust 언어가 설치되어 있지 않다면 rustup을 설치한다. (rust 언어가 있더라도 rustup을 추천합니다)
4. (macOS 기준) 터미널 창에 cargo install mdbook 커맨드를 입력하여 mdbook을 설치한다.
5. 소스코드 안에서 수정할 내용을 수정한다.
6. 터미널에서 clone 했던 repository에 가서 mdbook build 커맨드를 입력한다. (책을 빌드하는 과정)
7. mdbook serve 커맨드를 입력하여 로컬 호스트에서 빌드 된 책을 열어본다.
8. mdbook watch 커맨드를 사용하면 파일이 수정될 때마다 자동으로 책을 빌드해준다.
9. 의미있는 변경이 생길 때마다 git commit을 해준다.
10. 모든 수정 / 추가 과정이 끝나면 git push를 한 뒤 오리지널 repository에 pull request를 한다.
11. 만약 코드 merge가 불가능한 상황이면 clone한 repository를 rebase한다.
12. 다시 pull request를 한다.
13. 끝!!!