KusionStack/kusion

Help us improve the quality of our website documentation and code comments in English

Open

#1,166 opened on Jun 14, 2024

View on GitHubContributor guide
 (7 comments) (1 reaction) (0 assignees)Go (108 forks)auto 404
good first issuehacktoberfesthelp wantedkind/documentation

Repository metrics

Stars
 (1,315 stars)
PR merge metrics
 (PR metrics pending)

Description

As none of our current maintainers are native English speakers, it's inevitable that there are mistakes in our website and code comments. To make sure that our users can clearly understand our work, we would greatly appreciate your help in improving the quality of our documentation.

  • For code comments, you can submit pull requests to this repo directly.
  • For website documentation, you can submit pull requests in the website repo

Contributor guide

Research direction
Read the website and code comments, identify grammar and spelling mistakes, then fix them. For code comments, locate files and make corrections; for website, submit PR to the website repo.
Tech stack
None
Domain
documentation
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.
Under 1 hour
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