stackabletech / stackabletech/documentation

Create a developer 'Quickstart' page

Offen
#557 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
CSS
Sterne
13
Forks
14
Ø Merge
4 T. 8 Std.
Gemergte PRs (30 T.)
10

Beschreibung

As a contributor with maybe some previous knowledge, I don't want to read lenghty instructions on how to get geoing. I want to read a quick page that is mostly shell script commands that I can run to get going.

The goal should be to have a dev environemnt where I can change things in the operator and test it in kind.

steps:

  • show how to install the dependencies (apt install gzip kind kuttl ...)
    • Problem: Lot's of tools, a lot of them installable in a different way, annoying to maintain such a list
  • configure git signing
  • show how to make changes to an operator
    • git clone
    • make a change
    • run checks (cargo clippy --all-targets)
    • run ./scripts/test.sh
    • Raise PR

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der vorhandenen Dokumentation des Repositorys für Mitwirkende und zur Entwicklung und verwende dann die im Issue genannten Befehle, einschließlich cargo clippy --all-targets und ./scripts/test.sh. Die Seite ist fertig, wenn sie eine prägnante Einrichtung der Abhängigkeiten und der Git-Signierung, die Schritte zum Klonen/Ändern/Prüfen/Erstellen eines PRs sowie eine Erklärung zum Testen des Operators in kind enthält.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
git, rust, shell
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.