좋은 튜토리얼의 원칙
이 원칙을 담은 talkol의 원본 댓글입니다:
다음은 신규 기여자를 위해 이러한 사항을 요약한 것입니다.
원칙
전체 흐름은 사용자의 클라이언트에서 실행되어야 합니다. 타사 서비스가 개입되어서는 안 됩니다. 사용자가 리포지토리를 간단히 복제하고 즉시 실행할 수 있도록 모든 작업을 수행해야 합니다.
README는 매우 상세해야 합니다. 사용자가 아무것도 모른다고 가정하지 마세요. 튜토리얼에 필요한 경우 장치에 FunC 컴파일러 또는 Lite 클라이언트를 설치하는 방법도 설명해야 합니다. 이 문서의 다른 튜토리얼에서 이러한 부분을 복사할 수 있습니다.
사용자가 표준 코드를 약간만 변경할 수 있도록 저장소에 사용된 컨트랙트의 전체 소스 코드가 포함되어 있으면 좋을 것 같습니다. 예를 들어, Jetton 스마트 컨트랙트를 사용하면 사용자 지정 동작을 실험할 수 있습니다.
가능하다면 사용자가 코드를 다운로드하거나 아무것도 구성하지 않고도 프로젝트를 배포하거나 실행할 수 있는 사용자 친화적인 인터페이스를 만드세요. 사용자 기기에서 100% 클라이언트 측에서 실행되도록 독립형이어야 하며 GitHub 페이지에서 제공되어야 합니다. 예: https://minter.ton.org/
사용자에게 모든 필드 선택의 의미를 설명하고 모범 사례를 설명하세요.
보안에 대해 알아야 할 모든 것을 설명하세요. 크리에이터가 실수하여 위험한 스마트 컨트랙트/봇/웹사이트를 만들지 않도록 충분히 설명해야 하며, 이는 최고의 보안 관행을 가르치는 것입니다.
리포지토리에는 튜토리얼의 맥락에서 가장 잘 구현하는 방법을 독자에게 보여주는 잘 작성된 테스트가 포함되어야 합니다.
리포지토리에는 이해하기 쉬운 자체 컴파일/배포 스크립트가 있어야 합니다. 사용자는 'npm 설치'만 하면 사용할 수 있어야 합니다.
때로는 GitHub 리포지토리로 충분하며 전체 문서를 작성할 필요가 없습니다. 리포지토리에 필요한 모든 코드가 포함된 README만 있으면 됩니다. 이 경우 사용자가 쉽게 읽고 이해할 수 있도록 코드에 주석을 잘 달아야 합니다.