KusionStack / KusionStack/kusion

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

Open
#1,166 7 comments 1 reaction 0 assignees View on GitHub
good first issue hacktoberfest help wanted kind/documentation
Dominant language
Go
Stars
1.3k
Forks
108
Avg merge
11m
Merged PRs (30d)
1

Description

As none of our current maintainers are native English speakers, it's inevitable that there are mistakes in our [website](https://www.kusionstack.io/) 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](https://github.com/KusionStack/kusionstack.io)

Contributor guide

Open the contributing guide

Research direction

Review the repository's English code comments and the documentation on the linked website. For code comments, make focused pull requests to this repository; for website documentation, work in the linked KusionStack/kusionstack.io repository. Done means the selected text is clearer and the relevant pull request is ready for review.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.