testing-handbook

Trail of Bits 테스트 핸드북 - appsec.guide

🎥 웨비나

🚧 공사 중

• kAFL
• Rust
• 공식 검증 및 Tamarin

기여 방법

Testing Handbook에 기여하고 싶다면, 시작하는 데 도움이 될 몇 가지 지침은 다음과 같습니다.

1. 새 도구 추가: Testing Handbook에서 새로운 도구를 다루고 싶다면 GitHub Issues에 주제를 제안하세요. 그런 다음 새로운 풀 리퀘스트를 작업할 수 있습니다.
2. 기존 챕터 개선: 특정 챕터를 개선할 아이디어가 있다면 GitHub 이슈를 추가할 수 있습니다.
3. 작은 작업 선택: 시간이 많지 않지만 여전히 기여하고 싶다면 GitHub 이슈 목록에서 작은 작업을 선택할 수 있습니다.
4. 문제 보고: 작은 기술적 문제나 오타를 발견하면 새 GitHub 이슈를 생성하거나 새 풀 리퀘스트에서 수정하세요.

편리한 개발을 위한 빠른 설정

1. 시스템에 Hugo 설치

   root@kitploit:~

   brew install hugo
   

2. 리포지토리 클론

   root@kitploit:~

   git clone --recurse-submodules https://github.com/trailofbits/testing-handbook.git
   

3. 작업할 새 브랜치를 만들거나 브랜치 선택

   root@kitploit:~

   cd testing-handbook
   # then
   git checkout -b name-of-your-new-branch
   # or
   git checkout name-of-existing-branch
   

4. 프로젝트 루트 디렉토리에서 드래프트를 켠 상태(-D)로 Hugo 서버를 실행하세요. 파일을 저장할 때마다 브라우저가 변경 사항으로 자동 새로고침됩니다.

   root@kitploit:~

   hugo server -D
   

5. 새 도구를 "doc"로 추가하고, 프로젝트 루트 디렉토리에서 다음을 실행하세요.

   root@kitploit:~

   hugo new docs/<name of tool>
   

   참고: 이 프로젝트는 zkdocs와 동일한 hugo 템플릿을 사용합니다. 템플릿은 각 새 페이지를 포스트가 아닌 "doc"로 지칭합니다. 따라서 hugo new docs/<도구 이름>을 입력하고 post/my-new-post가 아닌 이유입니다.

6. 변경 사항을 편집, 추가하고, main에 병합하기 위한 풀 리퀘스트를 만드세요.

7. ❗PR을 main에 병합하면 콘텐츠가 https://appsec.guide에 실시간으로 게시된다는 점을 명심하세요. 현재 정책은 병합 전에 최소 한 번의 리뷰를 요구합니다.

8. 홈 페이지 업데이트는 content/_index.md를 편집하세요.

가이드라인

• 각 "doc" 간에 형식이 일관되어야 합니다. 새 doc를 추가할 때(즉, 새 도구를 추가할 때) content/docs/template.md의 템플릿을 따르세요. 필요에 따라 이 파일에 대한 PR을 변경 제안과 함께 보내주세요.

• 변경 사항이 있는 새 브랜치를 만들고, 작업이 완료되면 main에 병합하기 위한 PR을 만드세요.

• 이 리포지토리의 GitHub 워크플로우는 세 가지 검사를 통해 Markdown 파일의 정확성을 검증합니다:

  1. Markdown 링크 검사: 이 단계는 Markdown 파일에서 링크를 추출하여 유효하고 접근 가능한지 확인합니다. lychee 링크 확인 액션을 사용합니다.
  2. Markdown Linter: 이 단계는 Markdown 파일이 원하는 스타일 및 형식 규칙을 준수하는지 확인합니다. 사용자 정의 구성 파일(.github/workflows/.markdownlint.jsonc)과 markdownlint-cli2-action 액션을 사용합니다. Testing Handbook 작업 시 더 나은 사용자 경험을 위해 Visual Studio Code와 함께 markdownlint 확장 프로그램을 사용하세요.
  3. 맞춤법 검사: 이 단계는 Markdown 파일의 맞춤법을 확인합니다. (retext 및 remark 기반). tbroadley/spellchecker-cli-action 액션을 사용합니다.

• Hugo Book 테마에 익숙해지세요. 몇 가지 멋진 기능(버튼 등)이 있습니다.

• 질문이 있으면 Empire Hacking Slack의 #testing-handbook에서 문의하세요.

편집

작성 가이드라인

• "Testing Handbook"이라는 용어는 웹사이트에 나타날 때마다(헤더/서브헤더 또는 본문 텍스트에서) 대문자로 표기해야 합니다. 이는 문서의 제목이기 때문입니다. 하지만 대문자 표기가 어색해 보인다면 "Testing Handbook" 대신 "this handbook"을 사용할 수 있습니다(핸드북의 제목이 무엇인지 충분히 명확하므로).

워크플로우: Google Docs에서

Google Docs에서 문서를 Markdown으로 내보낼 수 있습니다. Google Docs에서 문서를 엽니다. 파일 > 다운로드를 클릭한 다음 Markdown (.md)을 선택합니다.

사용자 정의 환경