kmesh-net/kmesh

Supplement guiding doc for developer

Open

#375 opened on May 27, 2024

View on GitHubContributor guide
 (2 comments) (1 reaction) (2 assignees)Go (239 forks)auto 404
good first issue

Repository metrics

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

Description

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 direction
Examine the existing build guide at https://kmesh.net/en/docs/developer/build guide/, find the test and benchmark commands in the repository (likely in Makefile or scripts), and create a new doc page with steps to run unit tests and benchmarks.
Tech stack
go
Domain
backenddocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80