kmesh-net/kmesh

Can you add a developer guide

Open

#217 opened on Apr 12, 2024

View on GitHubContributor guide
 (4 comments) (0 reactions) (1 assignee)Go (239 forks)auto 404
help wanted

Repository metrics

Stars
 (739 stars)
PR merge metrics
 (PR metrics pending)

Description

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 direction
Review the existing developer guide checklist and fill in the missing sections: Developer Environment Requirements, eBPF dev tools dependencies, and Coding conventions. Gather information from the project's codebase, build scripts, and community guidelines.
Tech stack
go
Domain
backendnetworking
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGo
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75