kmesh-net/kmesh

Can you add a developer guide

Offen

#217 geöffnet am 12.04.2024

Auf GitHub ansehenContributor Guide
 (4 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Go (239 Forks)auto 404
help wanted

Repository-Metriken

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

Beschreibung

I have roughly thought about several parts that should be listed:

  • 1. Developer Env requirement: os, kernel, etc. golang, kubernetes, istio version
  • 2. ebpf dev tools dependencies
  • 3. Coding conventions
  • 4. How to write a ut and how to run a ut
  • 5. How to build
  • 6. How to install and test kmesh (This probably should be within use guide)

Contributor Guide

Research-Richtung
Überprüfen Sie die vorhandene Checkliste für den Entwicklerleitfaden und füllen Sie die fehlenden Abschnitte aus: Entwicklerumgebungsanforderungen, eBPF Entwicklungstool Abhängigkeiten und Codierungskonventionen. Sammeln Sie Informationen aus der Codebasis des Projekts, den Build Skripten und den Community Richtlinien.
Tech Stack
go
Domain
backendnetworking
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
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
GitGo
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75