kmesh-net/kmesh

Supplement guiding doc for developer

Offen

#375 geöffnet am 27.05.2024

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (1 Reaktion) (2 zugewiesene Personen)Go (239 Forks)auto 404
good first issue

Repository-Metriken

Stars
 (739 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 6T 4h) (8 gemergte PRs in 30 T)

Beschreibung

We have guide on building https://kmesh.net/en/docs/developer/build-guide/

IMO, we still lack guide on how to run unit test and how to run benchmark

Contributor Guide

Research-Richtung
Untersuche die vorhandene Build Anleitung unter https://kmesh.net/en/docs/developer/build guide/, finde die Test und Benchmark Befehle im Repository (wahrscheinlich in Makefile oder Skripten) und erstelle eine neue Dokumentationsseite mit Schritten zum Ausführen von Unit Tests und Benchmarks.
Tech Stack
go
Domain
backenddocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80