Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sweep: Help me translate README into Chinese, name it README_zh-CN.md #82

Closed
3 tasks done
cubxxw opened this issue Aug 14, 2023 · 1 comment · Fixed by #84
Closed
3 tasks done

Sweep: Help me translate README into Chinese, name it README_zh-CN.md #82

cubxxw opened this issue Aug 14, 2023 · 1 comment · Fixed by #84
Labels
kind/feature Categorizes issue or PR as related to a new feature.

Comments

@cubxxw
Copy link
Member

cubxxw commented Aug 14, 2023

Checklist

  • I've searched for similar issues and couldn't find anything matching
  • I've discussed this feature request in the kubecub Slack and got positive feedback

Is this feature request related to a problem?

❎ No

Problem Description

我想要一份 中文 的 README ,通过 AI 翻译而来的

Solution Description

我希望最后能有一个中文的 README PR

Benefits

这个会让其他开发者 尤其是中国的开发者能看懂我们项目

Potential Drawbacks

No response

Additional Information

No response

Checklist
  • README_zh-CN.md
  • Create a new file named README_zh-CN.md.
    • Translate the content of the README.md file into Chinese. Ensure that the translation is accurate and that the original meaning is preserved.
    • Maintain the formatting and structure of the README.md file in the translated version. This includes headings, bullet points, code snippets, and links.
    • Review the README_zh-CN.md file to ensure that it is accurate and that it maintains the original formatting and structure of the README.md file.
@cubxxw cubxxw added the kind/feature Categorizes issue or PR as related to a new feature. label Aug 14, 2023
@sweep-ai sweep-ai bot added the sweep label Aug 14, 2023
@sweep-ai
Copy link
Contributor

sweep-ai bot commented Aug 14, 2023

Here's the PR! #84.

⚡ Sweep Free Trial: I used GPT-3.5 to create this ticket. You have 3 GPT-4 tickets left for the month and 0 for the day. For more GPT-4 tickets, visit our payment portal.To get Sweep to recreate this ticket, leave a comment prefixed with "sweep:" or edit the issue.


Step 1: 🔍 Code Search

I found the following snippets in your repository. I will now analyze these snippets and come up with a plan.

Some code snippets I looked at (click to expand). If some file is missing from here, you can mention the path in the ticket description.

https://github.com/kubecub/go-project-layout/blob/28cee1748a8d97f0155b540b93abf2c127c34764/README_zh-CN.md#L1-L0

+ feature design
+ help wanted
+ doc incomplete
+ test improvement
+ any questions on go-project-layout project
+ and so on
Also, we must be reminded when submitting a new question about go-project-layout, please remember to remove the sensitive data from your post. Sensitive data could be password, secret key, network locations, private business data and so on.
#### Commit Rules
Actually in go-project-layout, we take two rules serious when committing:
**🥇 Commit Message:**
Commit message could help reviewers better understand what the purpose of submitted PR is. It could help accelerate the code review procedure as well. We encourage contributors to use **EXPLICIT** commit message rather than ambiguous message. In general, we advocate the following commit message type:
We use [Semantic Commits](https://www.conventionalcommits.org/en/v1.0.0/) to make it easier to understand what a commit does and to build pretty changego-project-layouts. Please use the following prefixes for your commits:
+ `docs: xxxx`. For example, "docs: add docs about storage installation".
+ `feature: xxxx`.For example, "feature: make result show in sorted order".
+ `bugfix: xxxx`. For example, "bugfix: fix panic when input nil parameter".
+ `style: xxxx`. For example, "style: format the code style of Constants.java".
+ `refactor: xxxx.` For example, "refactor: simplify to make codes more readable".
+ `test: xxx`. For example, "test: add unit test case for func InsertIntoArray".
+ `chore: xxx.` For example, "chore: integrate travis-ci". It's the type of mantainance change.
+ other readable and explicit expression ways.
On the other side, we discourage contributors from committing message like the following ways:
+ ~~fix bug~~
+ ~~update~~
+ ~~add doc~~
**🥈 Commit Content:**
Commit content represents all content changes included in one commit. We had better include things in one single commit which could support reviewer's complete review without any other commits' help.
In another word, contents in one single commit can pass the CI to avoid code mess. In brief, there are two minor rules for us to keep in mind:
1. avoid very large change in a commit.
2. complete and reviewable for each commit.
3. words are written in lowercase English, not uppercase English or other languages such as Chinese.
No matter what the commit message, or commit content is, we do take more emphasis on code review.
An example for this could be:
```bash
❯ git commit -a -s -m "docs: add a new section to the README"
```
#### PR Description
PR is the only way to make change to go-project-layout project files. To help reviewers better get your purpose, PR description could not be too detailed. We encourage contributors to follow the [PR template](https://github.com/kubecub/go-project-layout/tree/main/.github/PULL_REQUEST_TEMPLATE.md) to finish the pull request.
You can find some very formal PR in [RFC](https://github.com/kubecub/go-project-layout/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) issues and learn about them.
**📖 Opening PRs:**
+ As long as you are working on your PR, please mark it as a draft
+ Please make sure that your PR is up-to-date with the latest changes in `main`
+ Mention the issue that your PR is addressing (Fix: #{ID_1}, #{ID_2})
+ Make sure that your PR passes all checks
**🈴 Reviewing PRs:**
+ Be respectful and constructive
+ Assign yourself to the PR
+ Check if all checks are passing
+ Suggest changes instead of simply commenting on found issues
+ If you are unsure about something, ask the author
+ If you are not sure if the changes work, try them out
+ Reach out to other reviewers if you are unsure about something
+ If you are happy with the changes, approve the PR
+ Merge the PR once it has all approvals and the checks are passing
**⚠️ DCO check:**
We have a DCO check that runs on every pull request to ensure code quality and maintainability. This check verifies that the commit has been signed off, indicating that you have read and agreed to the provisions of the Developer Certificate of Origin. If you have not yet signed off on the commit, you can use the following command to sign off on the last commit you made:
```bash
❯ git commit --amend --signoff
```
Please note that signing off on a commit is a commitment that you have read and agreed to the provisions of the Developer Certificate of Origin. If you have not yet read this document, we strongly recommend that you take some time to read it carefully. If you have any questions about the content of this document, or if you need further assistance, please contact an administrator or relevant personnel.
You can also automate signing off your commits by adding the following to your `.zshrc` or `.bashrc`:
```go
git() {
if [ $# -gt 0 ] && [[ "$1" == "commit" ]] ; then
shift
command git commit --signoff "$@"
else
command git "$@"
fi
}
```
#### Docs Contribution
The documentation for go-project-layout includes:
+ [README.md](https://github.com/kubecub/go-project-layout/blob/main/README.md): This file includes the basic information and instructions for getting started with go-project-layout.
+ [README_zh-CN.md](https://github.com/kubecub/go-project-layout/blob/main/README_zh-CN.md): This file includes the basic information and instructions for getting started with kubecub in Chinese.
+ [CONTRIBUTING.md](https://github.com/kubecub/go-project-layout/blob/main/CONTRIBUTING.md): This file contains guidelines for contributing to go-project-layout's codebase, such as how to submit issues, pull requests, and code reviews.
+ [Official Documentation](https://nsddd.top): This is the official documentation for go-project-layout, which includes comprehensive information on all of its features, configuration options, and troubleshooting tips.
Please obey the following rules to better format the docs, which would greatly improve the reading experience.
1. Please do not use Chinese punctuations in English docs, and vice versa.
2. Please use upper case letters where applicable, like the first letter of sentences / headings, etc.
3. Please specify a language for each Markdown code blocks, unless there's no associated languages.
4. Please insert a whitespace between Chinese and English words.
5. Please use the correct case for technical terms, such as using `HTTP` instead of http, `MySQL` rather than mysql, `Kubernetes` instead of kubernetes, etc.
6. Please check if there's any typos in the docs before submitting PRs.
## Engage to help anything
We choose GitHub as the primary place for go-project-layout to collaborate. So the latest updates of go-project-layout are always here. Although contributions via PR is an explicit way to help, we still call for any other ways.
+ reply to other's [issues](https://github.com/kubecub/go-project-layout/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) if you could;
+ help solve other user's problems;
+ help review other's [PR](https://github.com/kubecub/go-project-layout/pulls) design;
+ discuss about go-project-layout to make things clearer;
+ advocate [go-project-layout](https://google.com/search?q=go-project-layout) technogo-project-layouty beyond GitHub;
+ write bgo-project-layouts on go-project-layout and so on.
In a word, **ANY HELP IS CONTRIBUTION.**
## Release version
Releases of go-project-layout are done using [Release Please](https://github.com/googleapis/release-please) and [GoReleaser](https://goreleaser.com/). The workflow looks like this:
🎯 A PR is merged to the `main` branch:
+ Release please is triggered, creates or updates a new release PR
+ This is done with every merge to main, the current release PR is updated every time
🎯 Merging the 'release please' PR to `main`:
+ Release please is triggered, creates a new release and updates the changego-project-layout based on the commit messages
+ GoReleaser is triggered, builds the binaries and attaches them to the release
+ Containers are created and pushed to the container registry
With the next relevant merge, a new release PR will be created and the process starts again
**👀 Manually setting the version:**
If you want to manually set the version, you can create a PR with an empty commit message that contains the version number in the commit message. For example:
Such a commit can get produced as follows:
````bash
❯ git commit --allow-empty -m "chore: release 0.0.3" -m "Release-As: 0.0.3
````
## Contact Us
We value close connections with our users, developers, and contributors here at kubecub. With a large community and maintainer team, we're always here to help and support you. Whether you're looking to join our community or have any questions or suggestions, we welcome you to get in touch with us.
Our most recommended way to get in touch is through [Slack](https://join.slack.com/t/c-ub/shared_invite/zt-1se0k2bae-lkYzz0_T~BYh3rjkvlcUqQ). Even if you're in China, Slack is usually not blocked by firewalls, making it an easy way to connect with us. Our Slack community is the ideal place to discuss and share ideas and suggestions with other users and developers of kubecub. You can ask technical questions, seek help, or share your experiences with other users of kubecub.
In addition to Slack, we also offer the following ways to get in touch:
+ <a href="https://join.slack.com/t/kubecub/shared_invite/zt-1se0k2bae-lkYzz0_T~BYh3rjkvlcUqQ" target="_blank"><img src="https://img.shields.io/badge/Slack-automation%2B-blueviolet?logo=slack&amp;logoColor=white"></a> We also have Slack channels for you to communicate and discuss. To join, visit https://slack.com/ and join our [👀 kubecub slack](https://join.slack.com/t/kubecub/shared_invite/zt-1se0k2bae-lkYzz0_T~BYh3rjkvlcUqQ) team channel.
+ <a href="https://mail.google.com/mail/u/0/?fs=1&tf=cm&to=3293172751nss@gmail.com" target="_blank"><img src="https://img.shields.io/badge/gmail-%40kubecub-blue?style=social&kubecubo=gmail&logo=gmail"></a> Get in touch with us on [📨Gmail: 3293172751nss@gmail.com](mailto:3293172751nss@gmail.com). If you have any questions or issues that need resolving, or any suggestions and feedback for our open source projects, please feel free to contact us via email.
+ <a href="https://nsddd.top" target="_blank"><img src="https://img.shields.io/badge/%E5%8D%9A%E5%AE%A2-%40kubecub-blue?style=social&logo=Octopus%20Deploy&logoColor=red"></a> Read our [🤖kubecub](https://nsddd.top). Our kubecub is a great place to stay up-to-date with kubecub projects and trends. On the kubecub, we share our latest developments, tech trends, and other interesting information.
+ <a href="https://twitter.com/xxw3293172751" target="_blank"><img src="https://img.shields.io/badge/twitter-%40kubecub-informational?kubecubo=twitter&style=flat-square&logo=twitter"></a> Add [🕊️Twitter](https://twitter.com/xxw3293172751) . If you prefer social media, our Twitter account is a great way to stay up-to-date with kubecub project news and trends. On Twitter, we share our latest tech and trends, as well as relevant news and events.
+ <a href="http://sm.nsddd.top/sm0d220ad72063197b9875379403f6c88.jpg" target="_blank"><img src="https://img.shields.io/badge/%E5%BE%AE%E4%BF%A1-smile-brightgreen?kubecubo=wechat&style=flat-square?logo=wechat"></a> Add [📲Wechat](https://img.shields.io/badge/%E5%BE%AE%E4%BF%A1-smile-brightgreen?kubecubo=wechat&style=flat-square) and indicate that you are a user or developer of kubecub. We will process your request as soon as possible.
Whether you're looking to join our community or have any questions or suggestions, we welcome you to get in touch with us.

I also found the following external resources that might be helpful:

Summaries of links found in the content:

https://join.slack.com/t/kubecub/shared_invite/zt-1se0k2bae-lkYzz0_T~BYh3rjkvlcUqQ:

The page is about Slack and its features. It includes information about downloading the Slack app for different platforms, such as Mac, Windows, Linux, iOS, and Android. The page also mentions Slack's product, pricing, support, and guides. It provides links to the Slack app directory, APIs, jobs, and events. The page includes legal information, such as privacy, security, terms of service, and brand guidelines. However, there is no specific information related to the problem described in the user's request.


Step 2: 🧐 Snippet Analysis

From looking through the relevant snippets, I decided to make the following modifications:

File Path Proposed Changes
README_zh-CN.md Modify README_zh-CN.md with contents:
* Create a new file named README_zh-CN.md.
• Translate the content of the README.md file into Chinese. Ensure that the translation is accurate and that the original meaning is preserved.
• Maintain the formatting and structure of the README.md file in the translated version. This includes headings, bullet points, code snippets, and links.
• Review the README_zh-CN.md file to ensure that it is accurate and that it maintains the original formatting and structure of the README.md file.

Step 3: 📝 Planning

I have created a plan for writing the pull request. I am now working my plan and coding the required changes to address this issue. Here is the planned pull request:

Translate README into Chinese (README_zh-CN.md)
sweep/translate-readme-chinese

Description

This PR adds a Chinese translation of the README file. A new file, README_zh-CN.md, has been created to contain the translated content. The translation is accurate and maintains the original formatting and structure of the README.md file.

Summary of Changes

  • Created a new file, README_zh-CN.md, for the Chinese translation of the README file.
  • Translated the content of the README.md file into Chinese, ensuring accuracy and preserving the original meaning.
  • Maintained the formatting and structure of the README.md file in the translated version.
  • Reviewed the README_zh-CN.md file to ensure accuracy and consistency with the original README.md file.

Please review and merge this PR to include the Chinese translation of the README file.


Step 4: ⌨️ Coding

File Instructions Progress
README_zh-CN.md Modify README_zh-CN.md with contents:
* Create a new file named README_zh-CN.md.
• Translate the content of the README.md file into Chinese. Ensure that the translation is accurate and that the original meaning is preserved.
• Maintain the formatting and structure of the README.md file in the translated version. This includes headings, bullet points, code snippets, and links.
• Review the README_zh-CN.md file to ensure that it is accurate and that it maintains the original formatting and structure of the README.md file.
✅ Commit b663a2a

Step 5: 🔁 Code Review

Here are my self-reviews of my changes at sweep/translate-readme-chinese.

Here is the 1st review

No changes required. The added file README_zh-CN.md is correctly implemented and there are no errors or unimplemented sections. Good job on the translation!

I finished incorporating these changes.


To recreate the pull request, or edit the issue title or description.
Join Our Discord

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants