Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
111 lines (71 loc) · 5.89 KB

CONTRIBUTING.md

File metadata and controls

111 lines (71 loc) · 5.89 KB

Welcome to the OpenChain KWG

OpenChain KWG에 기여하러 오신 모든 분들을 열렬히 환영합니다! OpenChain KWG은 여러분의 소중한 기여를 통해 성장하고 있습니다.

OpenChain KWG이 바라는 기여 분야와 방법은 다음과 같습니다.

웹사이트 개발

OpenChain KWG는 Hugo static site generator의 Theme인 Docsy를 기반으로 제작되었습니다.

이 웹사이트를 지속적으로 관리하고 개선하는 데 기여하실 수 있습니다. 웹사이트 개발은 GitHub에서 하며, 빌드, 배포 및 Pull Request 방법은 다음 페이지를 참고하세요.

웹사이트 자료 추가

OpenChain KWG의 모든 활동은 누구나 열람하고 사용할 수 있도록 웹사이트에 공개하고 있습니다. : https://openchain-project.github.io/OpenChain-KWG/

이 웹사이트에는 주기적으로 생성되는 다음과 같은 자료를 추가하고 있습니다.

새 미팅 페이지 생성 방법

미팅 페이지는 Archetype 템플릿을 사용하여 아래 절차로 생성합니다.

1단계: 발표자료 업로드

발표자료(PDF, PPTX 등)는 Git 저장소에 직접 커밋하지 않고, 반드시 GitHub Releases에 업로드합니다.

  • GitHub Releases 접속: https://github.com/OpenChain-Project/OpenChain-KWG/releases
  • 해당 연도의 Release 태그 선택 (예: meeting-slides-2026) 태그가 없으면 새로 생성:
    • Tag: meeting-slides-YYYY
    • Title: Meeting Slides YYYY
  • 파일명 규칙 준수 후 업로드:
    • 영문, 숫자, 하이픈(-), 언더스코어(_), 점(.)만 사용
    • 공백·한글·특수문자 사용 금지
    • 권장 형식: YYYYMMDD-발표자-주제키워드.pdf
    • 예시: 20260320-kakao-sbom-intro.pdf
  • 업로드 후 다운로드 URL 복사: https://github.com/OpenChain-Project/OpenChain-KWG/releases/download/meeting-slides-YYYY/파일명.pdf

2단계: 미팅 페이지 생성

Archetype 템플릿을 사용하여 ko/en 양쪽 페이지를 생성합니다.

# 예시: 29번째 미팅
hugo new content/ko/meeting/2026/29th/_index.md --kind meeting
hugo new content/en/meeting/2026/29th/_index.md --kind meeting

생성된 파일을 열어 아래 항목을 채웁니다:

  • Front Matter: title, date, description
  • 발표자료 표의 링크를 1단계에서 복사한 GitHub Releases URL로 교체

3단계: 커밋 및 배포

git add content/ko/meeting/29th/
git add content/en/meeting/29th/
git commit -m "feat: add 29th meeting page"
git push origin master

주의: static/ 또는 content/ 폴더에 PDF, PPTX 등 대용량 파일을 직접 커밋하지 마세요. GitHub Pages 1GB 용량 한도를 초과할 수 있습니다.

이러한 자료를 추가하는 데 기여하실 분을 모십니다. 자료를 추가하는 방법은 다음 페이지를 참고하세요!

오픈소스 문서 번역

OpenChain Project에서는 기업이 Open Source Compliance 활동을 하는 데 도움이 되는 문서 자료를 공개하고 있습니다. 대부분 영어로 되어 있기 때문에 이를 한국어로 번역하여 공개한다면 한국 기업의 오픈소스 담당자들에게 도움이 될 수 있습니다.

이러한 문서 번역에 기여해주세요.

문서 번역과 관련한 세부 사은 다음 페이지를 참고하세요. : https://openchain-project.github.io/OpenChain-KWG/resource/

오픈소스 Tool 조사 및 사용법 공개

Open Source Compliance를 효율적으로 수행하기 위해서는 자동화 도구가 필수적입니다. 글로벌 오픈소스 커뮤니티에서는 이러한 도구를 개발하여 오픈소스로 공개하고 있습니다. 이런 도구들을 먼저 사용해보고 사용법과 장단점 등을 분석하여 공개한다면 이 역시 한국 기업의 오픈소스 담당자들에게 큰 도움이 될 것입니다.

여러 분들의 많은 기여를 부탁 드립니다.

기여 방법은 Tool 사용법을 작성하여 Blog 형태의 문서로 공개할 수 있고, OpenChain KWG 정기 미팅 시 세미나 형태로 발표할 수도 있습니다.

또한, OpenChain KWG에는 Tooling Subgroup에서 오픈소스 도구에 대해 함께 연구하고 공유하고 있으니 참고하세요.

이외

이외 다양한 형태의 기여를 필요로 합니다.

여러분의 기여로 우리는 모두 함께 성장합니다!