Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 4.91 KB

File metadata and controls

64 lines (40 loc) · 4.91 KB

Genit Prompt IDE 기여 가이드

안녕하세요! Genit Prompt IDE(GPI) 프로젝트에 기여하고 싶으신 여러분을 진심으로 환영합니다. 🎉

이 프로젝트는 코딩을 전혀 몰라도 괜찮습니다. 여러분의 작은 아이디어나, AI의 도움을 받은 간단한 수정만으로도 프로젝트를 함께 발전시킬 수 있습니다. 이곳은 실력을 뽐내는 곳이 아닌, **모두가 안전하게 배우고 성장하는 '놀이터'**입니다.

💖 저희는 이런 기여를 기다립니다

저희는 특히 다음과 같은 'Level 1' 기여를 언제나 환영합니다. AI의 도움을 받거나, 간단한 문서 수정만으로도 충분히 할 수 있는 일들입니다.

  • 문서 개선: 오탈자를 수정하거나, 문장을 더 자연스럽게 다듬어주세요.
  • 번역 및 요약: README.md 같은 문서를 다른 언어(특히 영어)로 번역하거나 요약해주세요.
  • 스크린샷 추가: 문서에 설명된 기능의 스크린샷을 추가하여 다른 사람들이 더 쉽게 이해할 수 있도록 도와주세요.
  • 아이디어 제안: "이런 기능이 있으면 좋겠어요!" 와 같은 아이디어를 Issues에 자유롭게 남겨주세요.

🚀 생애 첫 기여, 차근차근 따라 해보기

GitHub가 처음이라도 괜찮습니다. 아래 안내를 순서대로 따라오시면, 여러분의 첫 기여를 성공적으로 마칠 수 있습니다. 저희는 GitHub 웹사이트에서 모든 것을 해결하는 가장 쉬운 방법을 안내해 드립니다.

1단계: 기여할 '퀘스트' 찾기

  1. 프로젝트 상단의 **Issues 탭**으로 이동합니다.
  2. [Level 1: Welcome!] 또는 good first issue 라벨이 붙은 이슈 목록을 살펴보세요.
  3. 마음에 드는 이슈를 클릭하고, "제가 한번 해보겠습니다!" 와 같이 간단한 댓글을 남겨주시면 다른 사람과 겹치지 않게 작업할 수 있습니다.

2단계: 내 작업 공간(Fork) 만들기

'Fork'는 원본 프로젝트를 여러분의 개인 계정으로 안전하게 복사하는 기능입니다.

  • genit-memory-helper 저장소 오른쪽 상단에 있는 Fork 버튼을 눌러주세요. 잠시 후 여러분의 GitHub 계정에 똑같은 이름의 저장소가 만들어집니다.

3단계: 파일 수정하고 저장(Commit)하기

이제 여러분의 개인 작업 공간에서 파일을 수정할 차례입니다.

  1. 수정하고 싶은 파일(예: README.md)을 클릭합니다.
  2. 파일 내용 오른쪽 위에 있는 연필 모양(✏️) 아이콘을 클릭하면 편집 모드로 들어갑니다.
  3. 필요한 내용을 수정하거나 추가합니다.
  4. 수정이 끝나면, 페이지 하단의 Commit changes 버튼을 누릅니다. 'Commit'은 여러분의 변경 사항을 하나의 '저장 단위'로 만드는 것입니다.
    • 첫 번째 칸에는 "docs: README 영어 요약 추가" 와 같이 변경 내용을 요약해서 적어주세요.
    • 두 번째 칸은 비워두셔도 괜찮습니다.

4단계: 원본 프로젝트에 변경 내용 제출(Pull Request)하기

이제 여러분이 작업한 내용을 원본 프로젝트에 반영해달라고 요청할 차례입니다. 이것을 'Pull Request(PR)'라고 부릅니다.

  1. 파일 수정 후 여러분의 Fork된 저장소로 돌아오면, Contribute 라는 초록색 버튼이 보일 겁니다. 이 버튼을 클릭하고 Open pull request 를 선택하세요.
  2. PR 제목과 내용을 작성하는 페이지가 나옵니다.
    • 제목(Title): 어떤 작업을 했는지 명확하게 적어주세요. (예: README.md 영어 요약 추가)
    • 내용(Leave a comment): 작업한 내용에 대해 조금 더 자세히 설명하고, 관련 이슈가 있다면 Closes #이슈번호 (예: Closes #1)를 적어주세요. 이렇게 하면 PR이 반영될 때 관련 이슈가 자동으로 닫힙니다.
  3. Create pull request 버튼을 누르면 최종 제출이 완료됩니다!

💡 AI와 함께하는 우리만의 규칙

이 프로젝트는 AI와의 협업을 적극적으로 장려합니다.

  • 프롬프트 공유: PR을 제출하실 때, 어떤 AI(ChatGPT, Gemini 등)를 사용했고, 어떤 질문(프롬프트)을 했는지 간단히 공유해주세요. 여러분의 노하우가 다른 사람들에게 큰 도움이 됩니다.
  • 결과물은 꼭 확인: AI가 만들어준 결과물이라도, 제출하기 전에 내용이 올바른지 꼭 한번 확인해주세요.

이제 모든 준비가 끝났습니다. 여러분의 첫 기여가 프로젝트에 반영되고, 공식 기여자 목록에 여러분의 이름이 올라가는 멋진 경험을 하게 될 것입니다.

막히는 부분이 있다면, 언제든지 관련 이슈나 PR에 댓글로 질문해주세요. 저희가 친절하게 도와드리겠습니다!