이 저장소에는 create.roblox.com/docs에 있는 제작자 문서의 소스 코드가 들어 있습니다.
참고 : 현재 저장소에는 가이드, 튜토리얼, 교육 콘텐츠 및 Engine API 참조가 있습니다. 코드 샘플이 곧 제공될 예정입니다.
GitHub 기여 프로세스에 익숙하지 않은 경우 끌어오기 요청 정보 및 다음 비디오를 참조하세요.
문서에서 문제를 발견하고 끌어오기 요청을 제출하고 싶지 않은 경우 Roblox 개발자 포럼에 보고하여 알려주시기 바랍니다.
Roblox 제작자 문서에 추가되는 모든 내용은 더 큰 전체에 맞아야 합니다. 즉, 포괄적이고 정확하며 잘 작성된 블로그 게시물이나 기술 백서라도 웹 사이트에 존재하지 않을 수 있습니다.
일반적으로 우리는 기존 표준을 준수하고 다양한 경험과 사용 사례에 적용되는 콘텐츠를 찾습니다. 예를 들어, 레이싱 게임용 속도계 만들기 같은 페이지보다 사용자 인터페이스 만들기 같은 페이지를 선호합니다. Roblox 개발자 포럼에 보다 전문적인 가이드를 게시해 보세요.
검토를 위해 풀 요청을 제출할 때 다음 사항에 동의해야 합니다.
이 기여는 전체 또는 일부가 내가 작성했으며 이 저장소의 오픈 소스 라이센스 조건에 따라 제출할 권리가 있습니다.
나는 이 기여와 그에 대한 기록이 공개되고 무기한 유지되며 이 저장소의 오픈 소스 라이센스 조건에 따라 재배포될 수 있음을 이해하고 이에 동의합니다.
내가 아는 한, 제안된 모든 변경사항은 정확합니다.
단일 파일만 수정하는 간단한 변경의 경우 GitHub의 웹 기반 편집기를 사용하세요.
content/en-us/ 에서 파일을 찾아 Edit this file(이 파일 편집)을 클릭합니다.
이 저장소 포크 를 클릭합니다.
변경한 후 변경 사항 커밋...을 클릭합니다.
변경 내용을 설명하는 커밋 메시지를 제공하고 변경 제안을 클릭합니다.
기본 저장소가 Roblox/creator-docs 이고 기본 분기가 main 인지 확인하세요. 변경 사항에 만족하는지 확인하고 Create pull request 를 클릭합니다.
마지막으로 풀 요청 설명에 세부 정보를 입력하고 풀 요청 생성을 클릭하세요.
여러 파일을 다루는 대규모 변경의 경우 브라우저에서 실행되는 Visual Studio Code 기반의 모든 기능을 갖춘 텍스트 편집기인 github.dev를 권장합니다.
저장소를 포크하십시오.
포크를 검색하는 동안 을 누르세요 . github.dev를 여는 키입니다.
소스 제어 메뉴에서 ... > 분기 > 분기 생성...을 클릭합니다.
지점 이름을 지정하고 지점으로 전환 을 클릭합니다.
Explorer 메뉴를 사용하여 content/en-us 에서 업데이트하려는 파일을 찾고 원하는 대로 변경합니다.
소스 제어 메뉴에서 변경 사항에 만족하는지 확인합니다.
커밋 메시지를 추가하고 Commit & Push 를 클릭합니다.
새 브라우저 탭에서 github.com/Roblox/creator-docs로 이동합니다.
비교 및 풀 요청을 클릭합니다.
기본 저장소가 Roblox/creator-docs 이고 기본 브랜치가 main 인지 확인하세요. 헤드 저장소는 포크와 브랜치여야 합니다.
마지막으로 풀 요청 설명에 세부 정보를 입력하고 풀 요청 생성을 클릭하세요.
또는 github.dev의 GitHub 또는 GitHub Pull Request 메뉴를 사용하여 Pull 요청을 제출할 수 있습니다. github.dev 사용에 대한 문서는 GitHub Codespaces를 참조하세요.
이 저장소는 매우 크므로 가능하면 온라인 옵션을 사용하는 것이 좋습니다. 그러나 일반적인 GitHub 워크플로에 이미 익숙하고 오프라인 텍스트 편집기를 사용하려는 경우 문서에 기여하기 위한 기본 단계는 다음과 같습니다.
Git 및 Git LFS를 설정합니다. 또는 GitHub Desktop과 같은 Git 클라이언트를 설치하세요.
이 저장소를 포크하십시오.
포크를 복제하십시오.
저장소 루트로 이동합니다.
새 지점을 만듭니다.
원하는 대로 변경하세요.
커밋하고 포크로 푸시한 후 이 저장소의 main 브랜치에 대한 풀 요청을 제출하세요.
자세한 단계는 CONTRIBUTING.md를 참조하세요.
Roblox 문서에는 세 가지 주요 문서 유형이 있습니다.
content/en-us/에 있는 .md 파일의 개념 및 작업 기반 가이드
가이드는 최종 결과에 대해 지나치게 규정하지 않고 기능이나 작업 흐름에 대해 알려줍니다. 개념과 기능을 소개하고 다양한 도구나 기타 접근 방식을 사용하여 수행할 수 있는 작업을 다룹니다.
가이드는 실용적인 실제 사용 사례, 이미지, 코드 조각 및 다이어그램으로부터 막대한 이점을 얻습니다. 대부분의 작업 기반 콘텐츠에는 번호가 매겨진 목록이 포함되어야 합니다.
content/en-us/reference에 있는 .yaml 파일의 API 참조 문서
API는 전적으로 참조 콘텐츠이며 기능 설명을 사용하고 적절한 경우 가이드에 연결해야 합니다. 다른 콘텐츠 유형보다 참조 콘텐츠는 간결하고 직접적이어야 합니다. 속성, 메서드, 이벤트 및 콜백에 대한 요약은 완전한 문장일 필요는 없습니다.
content/en-us/tutorials에 있는 .md 파일의 자습서
작업 기반 가이드에 비해 튜토리얼은 더 독립적이며 아무것도 없는 것에서 무언가 로 안내합니다. 특정한 것을 만드는 데 초점을 맞춘다는 것은 일반적으로 가이드보다 훨씬 더 규범적이라는 것을 의미합니다. 튜토리얼에서는 여러 기능과 개념을 동시에 다루면서 도구와 전략 간의 연결을 보여주는 경우가 많습니다.
귀하의 기여가 이러한 범주에 맞지 않거나 특히 좁은 주제를 다루는 경우 문서에 적합하지 않을 수 있습니다. Roblox 개발자 포럼에 게시해 보세요.
끌어오기 요청을 더 쉽게 검토할 수 있도록 편집 내용을 하나의 클래스나 기능으로 제한해 보세요. 버그 수정과 소규모 개선은 빠른 승인 가능성이 더 높습니다. 대형 가이드는 출판 전에 상당한 왕복 작업이 필요한 경우가 많습니다.
서식 문제를 방지하려면 Markdown을 작성하면서 미리 볼 수 있는 github.dev와 같은 텍스트 편집기를 사용하는 것이 좋습니다. 산문의 경우 STYLE.md의 지침을 따르십시오. 코드 샘플을 보려면 Lua 스타일 가이드를 사용하세요.
main 분기에 표시되는 내용에 따라 완전히 형식화된 페이지를 보려면 content/ 및 그 이전의 전체 URL을 바꾸십시오. basename index 있는 파일에는 해당 이름이 제거되어야 합니다. 예를 들어, "https://github.com/Roblox/creator-docs/blob/main/content/en-us/avatar/index.md" 페이지는 "https://create.roblox.com"에서 렌더링됩니다. /docs/en-us/avatar".
산문의 경우 이 프로젝트는 Creative Commons Attribution 4.0 International Public License를 사용합니다. 전체 라이선스 텍스트를 보려면 LICENSE를 참조하세요.
코드 샘플은 MIT 라이선스에 따라 제공됩니다. 전체 라이선스 텍스트를 보려면 LICENSE-CODE를 참조하세요.
개방적이고 환영하며 다양하고 포용적이며 건강한 커뮤니티를 유지하기 위해 이 프로젝트는 기여자 규약의 개정판을 시행합니다. 자세한 내용은 CODE_OF_CONDUCT.md를 참조하세요.
