기여 안내
전문 분야와 관계없이 GitHub PR로 문서 개선을 제안할 수 있습니다. 읽다가 이해하기 어려웠던 문장, 더 설명이 필요했던 부분, 제안에 보탤 경험을 알려 주세요. 오탈자 하나를 고치는 일도 기여입니다.
어디서 시작하면 좋을까요
전문 용어에 필요한 설명을 보태고, 긴 문장을 읽기 쉽게 다듬어 주세요.
빠진 설명·절차·지원 방안이나 고려할 상황을 보태 주세요.
잘못되거나 오래된 정보를 확인하고 바로잡아 주세요.
개인정보와 비공개 정보를 제외한 경험, 또는 가상의 사례를 보태 주세요.
문서를 읽기 쉽게 만드는 화면과 접근성 개선도 제안할 수 있습니다.
해결 방안을 정하지 못했어도 괜찮습니다. 어떤 상황에서 무엇을 더 살펴봐야 하는지, 그 이유를 질문으로 제안해 주세요. 프로젝트의 목적과 다루는 범위는 프로젝트 소개에서 확인할 수 있습니다.
수정안을 보내는 방법
수정안은 GitHub의 PR(Pull Request, 변경 내용을 보여주고 검토받는 요청)로 받습니다.
GitHub 저장소에서 Fork를 눌러 자신의 계정으로 저장소를 복사합니다.
복사한 저장소에서 해당 파일을 수정합니다. 짧은 문구 수정은 GitHub 웹 편집기에서도 할 수 있습니다.
변경 내용을 저장한 뒤 원래 저장소의 main 브랜치를 대상으로 PR을 엽니다.
바꾼 내용과 이유를 적습니다. 새로운 제안이라면 적용할 상황을, 법령·규정을 추가하거나 수정했다면 한국의 공식 출처를 함께 남겨 주세요.
한 PR에는 관련 있는 변경을 모아 주세요. 작은 수정은 “잘못 표기된 단어를 고쳤습니다”처럼 짧게 설명해도 됩니다.
함께 지킬 작성 기준
중요 정책을 우선 적용하고, 그 범위 안에서 문서 개선 기준을 적용해 주세요.
중요 정책
중요 정책은 프로젝트의 성격과 운영 기준을 명확히 하여 분쟁을 예방하기 위한 것입니다.
특정 개인·기업·기관·서비스를 지목해 평가하거나 비판하는 표현은 피해 주세요. 사례와 제안은 일반적인 상황과 필요한 설명·절차·지원에 초점을 맞춰 주세요.
제안 초안을 확정된 규정이나 검증된 보안 대책으로 표현하지 말아 주세요.
기여 안내에 명시되지 않은 사유로도 프로젝트 주 관리자의 판단에 따라 기여 제안이나 PR이 거절될 수 있습니다.
정책과 기여 기준은 프로젝트 운영 과정에서 계속 갱신될 수 있습니다.
문서 개선 기준
한국어로 짧고 구체적으로 써 주세요.
전문 용어는 정확한 명칭을 그대로 사용하고, 각 문서에서 문맥상 적절한 위치에 한 번 설명해 주세요. 이후에는 설명을 반복하지 않고 해당 용어를 사용해 주세요. 해설에서도 원래 의미와 적용 범위를 유지해 주세요.
법령·규정은 한국의 것만 다루고, 공식 출처와 기준일·적용 범위를 밝혀 주세요. 법령·규정 외의 설명에는 출처를 적지 말아 주세요.
공개할 자료
개인정보, 비밀값과 조직의 비공개 자료는 제외하고, 직접 작성했거나 사용할 권한이 있는 내용만 보내 주세요.
경험이나 사례를 공유할 때 보안·클라우드 회사 등의 영업기밀이 실수로 포함되지 않도록 주의해 주세요. 제출 전에 본문과 첨부 자료에 비공개 기술·운영·계약 정보가 들어 있지 않은지 확인해 주세요.
보내기 전에
한글과 기호가 깨지지 않았는지, 링크가 의도한 곳으로 연결되는지 다시 읽고 확인해 주세요. 공개하면 안 되는 정보나 관계없는 변경이 섞이지 않았는지도 살펴봐 주세요.
사이트 코드를 수정했다면 확인한 화면·동작과 아직 확인하지 못한 부분을 PR에 적어 주세요. 기여한 내용은 이 프로젝트의 MIT 라이선스로 제공되므로, 제출 전에 해당 조건으로 제공할 권한이 있는지 확인해 주세요.
파일을 추가하거나 이름을 바꿀 때
운영체제에 따라 파일 이름을 처리하는 방식이 달라 다음 기준을 사용합니다.
문서는 UTF-8(BOM 없음)으로 저장합니다.
docs/ 안의 문서는 무작위 UUID v4를 영문 소문자로 적고 .md 확장자를 붙입니다. 제목이나 내용을 바꿔도 UUID는 유지합니다. 문서용 폴더 이름에는 영문 소문자·숫자·하이픈(-)을 사용합니다.
공백이나 < > : " / \ | ? * 기호를 넣지 않고, 이름 끝에 마침표를 붙이지 않습니다.
Windows 예약 이름인 con, prn, aux, nul, com1~com9, lpt1~lpt9는 사용하지 않습니다. 대소문자를 바꾸거나 확장자를 붙여도 같습니다.
대소문자만 다른 파일이나 폴더를 따로 만들지 않습니다. 링크 경로는 실제 이름의 대소문자까지 맞춥니다.
README.md, LICENSE.ko.md, .github, .nojekyll처럼 관례나 도구에 따른 이름은 유지합니다. 사이트 소스와 설정 파일은 기존 코드와 도구의 명명 관례를 따릅니다.
파일명에는 위 기준을 적용하고, 문서의 제목과 본문은 한국어로 작성합니다.
로컬 저장소에서 npm run docs:new를 실행하면 UUID 파일명과 프론트매터 템플릿을 갖춘 문서가 생성됩니다. 제목과 본문, 요약인 description, 표시 순서인 order를 작성해 주세요.
새 문서는 published: false로 시작합니다. 웹사이트에 공개할 준비가 되면 따옴표 없이 published: true로 바꿔 주세요. false인 문서는 홈 목록, 상세 페이지와 사이트맵에서 제외되지만, 공개 GitHub 저장소에 올린 원본은 누구나 볼 수 있습니다.
제안은 이렇게 검토합니다
프로젝트의 목적에 맞는지, 근거가 충분하고 이해하기 쉬운지 살펴봅니다. 필요한 경우 추가 설명이나 수정을 요청하며, 검토 결과에 따라 반영 여부를 정합니다. 반영한 내용도 이후 검토와 기여를 통해 보완할 수 있습니다.