testing-handbook

Trail of Bits Testhandbuch - appsec.guide

✅ Veröffentlicht

🎥 Webinare

🚧 In Arbeit

• kAFL
• Rust
• Formale Verifikation und Tamarin

So kannst du beitragen

1. Neues Tool hinzufügen: Wenn du ein neues Tool im Testing-Handbuch behandeln möchtest, schlage ein Thema in den GitHub Issues vor. Danach kannst du an einem neuen Pull-Request arbeiten.
2. Bestehende Kapitel verbessern: Wenn du eine Idee hast, ein bestimmtes Kapitel zu verbessern, kannst du ein GitHub-Issue hinzufügen.
3. Kleine Aufgaben übernehmen: Wenn du nicht viel Zeit hast, aber trotzdem beitragen möchtest, kannst du jede kleine Aufgabe aus der GitHub-Issues-Liste übernehmen.
4. Probleme melden: Wenn du einen kleinen technischen Fehler oder einen Tippfehler findest, erstelle ein neues GitHub-Issue und/oder behebe es im neuen Pull-Request.

Schnelle Einrichtung für komfortable Entwicklung

1. Installiere Hugo auf deinem System

   root@kitploit:~

   brew install hugo
   

2. Klone das Repository

   root@kitploit:~

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

3. Erstelle einen neuen Branch oder wähle einen Branch aus, an dem du arbeiten möchtest

   root@kitploit:~

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

4. Führe den Hugo-Server mit aktivierten Entwürfen (-D) aus dem Projektstammverzeichnis aus. Dein Browser wird bei jeder Speicherung einer Datei automatisch mit den Änderungen aktualisiert.

   root@kitploit:~

   hugo server -D
   

5. Füge ein neues Tool als „doc“ hinzu und führe den folgenden Befehl aus dem Projektstammverzeichnis aus.

   root@kitploit:~

   hugo new docs/<name of tool>
   

   Hinweis: Dieses Projekt verwendet dieselbe Hugo-Vorlage wie zkdocs. Die Vorlage bezeichnet jede neue Seite als „doc“, nicht als Beitrag. Deshalb solltest du hugo new docs/<name of tool> eingeben und nicht post/my-new-post.

6. Bearbeite, ergänze und erstelle Pull-Requests, um deine Änderungen in main zu mergen.

7. ❗Beachte, dass der Inhalt live auf https://appsec.guide geht, wenn du deinen PR in main mergeest. Unsere derzeitige Richtlinie verlangt mindestens eine Überprüfung vor dem Mergen.

8. Für Aktualisierungen der Startseite bearbeite content/_index.md

Richtlinien

• Das Format sollte in jedem „doc“ konsistent sein. Wenn du ein neues doc hinzufügst (d. h. ein neues Tool), folge der Vorlage in content/docs/template.md. Sende bei Bedarf einen PR für diese Datei mit vorgeschlagenen Änderungen.

• Erstelle einen neuen Branch mit deinen Änderungen und erstelle einen PR, um in main zu mergen, wenn du fertig bist.

• Der GitHub-Workflow in diesem Repository überprüft die Korrektheit der Markdown-Dateien anhand von drei Prüfungen:

  1. Markdown-Linkprüfung: Dieser Schritt extrahiert Links aus Markdown-Dateien und prüft, ob sie gültig und erreichbar sind. Er verwendet die lychee-Linkprüfungs-Action.
  2. Markdown-Linter: Dieser Schritt stellt sicher, dass Markdown-Dateien dem gewünschten Stil und den Formatierungsregeln entsprechen. Er verwendet eine benutzerdefinierte Konfigurationsdatei (.github/workflows/.markdownlint.jsonc) und die markdownlint-cli2-action-Action. Verwende die markdownlint-Erweiterung mit Visual Studio Code für eine bessere Benutzererfahrung bei der Arbeit am Testing-Handbuch.
  3. Rechtschreibprüfung: Dieser Schritt prüft die Rechtschreibung in Markdown-Dateien (basierend auf retext und remark). Verwendet die tbroadley/spellchecker-cli-action-Action.

• Mach dich mit dem Hugo-Book-Theme vertraut, da es einige nützliche Funktionen bietet (z. B. Schaltflächen).

• Melde dich im #testing-handbook-Kanal des Empire-Hacking-Slack, wenn du Fragen hast.

Bearbeiten

Schreibrichtlinien

• Der Begriff „Testing-Handbuch“ sollte auf der Website immer großgeschrieben werden (ob in einer Überschrift/Unterüberschrift oder im Fließtext), da es sich um den Titel eines Dokuments handelt. Wenn du die Großschreibung jedoch vermeiden möchtest, weil sie seltsam aussieht, kannst du „Testing-Handbuch“ durch „dieses Handbuch“ ersetzen (da klar genug ist, wie der Titel des Handbuchs lautet).

Arbeitsablauf: Aus Google Docs

Du kannst das Dokument aus Google Docs als Markdown exportieren. Öffne das Dokument in Google Docs. Klicke auf Datei > Herunterladen und wähle dann Markdown (.md).

Benutzerdefinierte Umgebungen