-
Notifications
You must be signed in to change notification settings - Fork 41
docs: 修改中英文的readme文档名,增加贡献指南英文版 #7
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,76 +1,76 @@ | ||
| # 贡献指南 | ||
| # Contributing | ||
|
|
||
| 很高兴你有意愿参与 TinyCLI 开源项目的贡献,参与贡献的形式有很多种,你可以根据自己的特长和兴趣选择其中的一个或多个: | ||
| We are glad that you are willing to contribute to the TinyCLI open source project. There are many forms of contribution, and you can choose one or more of them according to your strengths and interests: | ||
|
|
||
| - 报告[新缺陷](https://github.com/opentiny/tiny-cli/issues/new?template=bug-report.yml) | ||
| - 为[已有缺陷](https://github.com/opentiny/tiny-cli/labels/bug)提供更详细的信息,比如补充截图、提供更详细的复现步骤、提供最小可复现demo链接等 | ||
| - 提交 Pull requests 修复文档中的错别字或让文档更清晰和完善 | ||
| - 添加官方小助手微信 opentiny-official,加入技术交流群参与讨论 | ||
| - Report [new defect](https://github.com/opentiny/tiny-cli/issues/new?template=bug-report.yml) | ||
| - Provide more detailed information for [existing defects](https://github.com/opentiny/tiny-cli/labels/bug), such as supplementary screenshots, more detailed reproduction steps, minimum reproducible demo links, etc. | ||
| - Submit Pull requests to fix typos in the document or make the document clearer and better | ||
| - Add the official assistant WeChat `opentiny-official` and join the technical exchange group to participate in the discussion. | ||
|
|
||
| 当你亲自使用 TinyCLI 组件库,并参与多次以上形式的贡献,对 TinyCLI 逐渐熟悉之后,可以尝试做一些更有挑战的事情,比如: | ||
| When you personally use the TinyCLI component library and participate in many of the above contributions, as you become familiar with TinyCLI, you can try to do something more challenging, such as: | ||
|
|
||
| - 修复缺陷,可以先从 [Good-first issue](https://github.com/opentiny/tiny-cli/labels/good%20first%20issue) 开始 | ||
| - 实现新特性 | ||
| - 完善单元测试 | ||
| - 翻译文档 | ||
| - 参与代码检视 | ||
| - Fix defects, you can start with [Good-first issue](https://github.com/opentiny/tiny-cli/labels/good%20first%20issue). | ||
| - Implement new features. | ||
| - Improve unit testing. | ||
| - Translate the document. | ||
| - Participate in code review. | ||
|
|
||
| ## 提交 Issue | ||
| ## Bug Reports | ||
|
|
||
| 如果你在使用 TinyCLI 组件过程中遇到问题,欢迎给我们提交 Issue,提交 Issue 之前,请先仔细阅读相关的[官方文档](https://opentiny.design),确认这是一个缺陷还是尚未实现的功能。 | ||
| If you encounter problems in the process of using TinyCLI components, you are welcome to submit Issue to us. Before submitting Issue, please read the relevant [official documentation](https://opentiny.design) carefully to confirm whether this is a defect or an unimplemented function. | ||
|
|
||
| 如果是一个缺陷,创建新 Issue 时选择 [Bug report](https://github.com/opentiny/tiny-cli/issues/new?template=bug-report.yml) 模板,标题遵循 `[toolkitName/pluginName/CliCore]缺陷简述` 的格式,比如:`[tiny-toolkit-xxx] xxx套件执行tiny start命令启动后提示xxx错误`。 | ||
| If it is a defect, select [Bug report](https://github.com/opentiny/tiny-cli/issues/new?template=bug-report.yml) template when creating a new Issue. The title follows the format of `[toolkitName/pluginName/CliCore] defect description`. For example: `[tiny-toolkit-xxx] a xxx error was occurred after the 'tiny start' command was run by the xxx toolkit`. | ||
|
|
||
| 报告缺陷的 Issue 主要需要填写以下信息: | ||
| - tiny-cli 和 node 的版本号 | ||
| - 缺陷的表现,可截图辅助说明,如果有报错可贴上报错信息 | ||
| - 缺陷的复现步骤,最好能提供一个最小可复现 demo 链接 | ||
| Issue that reports defects mainly needs to fill in the following information: | ||
| - Version numbers of `tiny` and `node`. | ||
| - The performance of the defect can be illustrated by screenshot, and if there is an error, the error message can be posted. | ||
| - Defect reproduction step, preferably with a minimum reproducible demo link. | ||
|
|
||
| 如果是一个新特性,则选择 [Feature request](https://github.com/opentiny/tiny-cli/issues/new?template=feature-request.yml) 模板,标题遵循 `[toolkitName/pluginName/CliCore]新特性简述` 的格式,比如:`[CliCore] 新增switch命令支持切换NPM源功能`。 | ||
| If it is a new feature, select [Feature request](https://github.com/opentiny/tiny-cli/issues/new?template=feature-request.yml) template. The title follows the format of `[toolkitName/pluginName/CliCore] new feature description`. For example: `[CliCore] added the switch command to support switching of the NPM source`. | ||
|
|
||
| 新特性的 Issue 主要需要填写以下信息: | ||
| - 该特性主要解决用户的什么问题 | ||
| - 该特性的 api 是什么样的 | ||
| The following information is required for the Issue of the new feature: | ||
| - What problems does this feature mainly solve for users? | ||
| - What is the api of this feature? | ||
|
|
||
| ## 提交 PR | ||
| ## Pull Requests | ||
|
|
||
| 提交 PR 之前,请先确保你提交的内容是符合 TinyCLI 整体规划的,一般已经标记为 [bug](https://github.com/opentiny/tiny-cli/labels/bug) 的 Issue 是鼓励提交 PR 的,如果你不是很确定,可以创建一个 [Discussion](https://github.com/opentiny/tiny-cli/discussions) 进行讨论。 | ||
| Before submitting pull request, please make sure that your submission is in line with the overall plan of TinyVue. Generally, issues that marked as [bug](https://github.com/opentiny/tiny-cli/labels/bug) are encouraged to submit pull requests. If you are not sure, you can create a [Discussion](https://github.com/opentiny/tiny-cli/discussions) for discussion. | ||
|
|
||
| 本地启动步骤: | ||
| Local startup steps: | ||
|
|
||
| - 点击 [TinyCLI](https://github.com/opentiny/tiny-cli) 代码仓库右上角的 Fork 按钮,将上游仓库 Fork 到个人仓库 | ||
| - Clone 个人仓库到本地 | ||
| - 在 Tiny CLI 根目录下运行 npm init, 安装依赖 | ||
| - 运行 npm run dev,启动本地代码编译开发 | ||
| - Click the Fork button in the upper right corner of the [TinyCLI](https://github.com/opentiny/tiny-cli) code repository to Fork the upstream repository to the personal repository. | ||
| - Clone personal repository to local. | ||
| - Run `npm init` under the TinyCLI root directory to install node dependencies. | ||
| - Run `npm run dev` to launch the local website for develop. | ||
|
|
||
| ```shell | ||
| # username 为用户名,执行前请替换 | ||
| # You need to replace username with your own user name | ||
| git clone git@github.com:username/tiny-cli.git | ||
| cd tiny-cli | ||
| git remote add upstream git@github.com:opentiny/tiny-cli.git | ||
| npm i | ||
|
|
||
| # 启动项目 | ||
| # Launch | ||
| npm run dev | ||
| ``` | ||
|
|
||
| 提交 PR 的步骤: | ||
| To submit a PR: | ||
|
|
||
| - 创建新分支 `git checkout -b username/feature1`,分支名字建议为 `username/feat-xxx` / `username/fix-xxx` | ||
| - 本地编码 | ||
| - 遵循 Commit Message Format 规范进行提交,不符合提交规范的 PR 将不会被合并 | ||
| - 提交到远程仓库:git push origin branchName | ||
| - (可选)同步上游仓库 dev 分支最新代码:git pull upstream dev | ||
| - 打开 TinyCLI 代码仓库的 [Pull requests](https://github.com/opentiny/tiny-cli/pulls) 链接,点击 New pull request 按钮提交 PR | ||
| - 项目 Committer 进行 Code Review,并提出意见 | ||
| - PR 作者根据意见调整代码,请注意一个分支发起了 PR 后,后续的 commit 会自动同步,无需重新提交 PR | ||
| - 项目管理员合并 PR | ||
| - Create a new branch `git checkout -b username/feature1`. The name of the branch should be `username/feat-xxx` / `username/fix-xxx`. | ||
| - Local coding. | ||
| - Submit according to [Commit Message Format](https://www.conventionalcommits.org/zh-hans/v1.0.0/) specification. PR that do not conform to the submission specification will not be merged. | ||
| - Submit to remote repository: `git push origin branchName`. | ||
| - (Optional) Synchronize upstream repository dev branch latest code: `git pull upstream dev`. | ||
| - Open the [Pull requests](https://github.com/opentiny/tiny-cli/pulls) link of the TinyCLI code repository and click the New pull request button to submit the PR. | ||
| - Project Committer conducts Code Review and makes comments. | ||
| - The PR author adjusts the code according to the opinion. Please note that when a branch initiates PR, the subsequent commit will be synchronized automatically, and there is no need to resubmit the PR. | ||
| - Project administrator merges PR. | ||
|
|
||
| 贡献流程结束,感谢你的贡献! | ||
| The contribution process is over, thank you for your contribution! | ||
|
|
||
| ## 加入开源社区 | ||
| ## Join OpenTiny community | ||
|
|
||
| 如果你对我们的开源项目感兴趣,欢迎通过以下方式加入我们的开源社区。 | ||
| If you are interested in our open source project, you are welcome to join our open source community in the following ways. | ||
|
|
||
| - 添加官方小助手微信:opentiny-official,加入我们的技术交流群 | ||
| - 加入邮件列表:opentiny@googlegroups.com | ||
| - Add official assistant WeChat: opentiny-official to join our technical exchange group. | ||
| - Add to the mailing list: opentiny@googlegroups.com | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| # 贡献指南 | ||
|
|
||
| 很高兴你有意愿参与 TinyCLI 开源项目的贡献,参与贡献的形式有很多种,你可以根据自己的特长和兴趣选择其中的一个或多个: | ||
|
|
||
| - 报告[新缺陷](https://github.com/opentiny/tiny-cli/issues/new?template=bug-report.yml) | ||
| - 为[已有缺陷](https://github.com/opentiny/tiny-cli/labels/bug)提供更详细的信息,比如补充截图、提供更详细的复现步骤、提供最小可复现demo链接等 | ||
| - 提交 Pull requests 修复文档中的错别字或让文档更清晰和完善 | ||
| - 添加官方小助手微信 opentiny-official,加入技术交流群参与讨论 | ||
|
|
||
| 当你亲自使用 TinyCLI 组件库,并参与多次以上形式的贡献,对 TinyCLI 逐渐熟悉之后,可以尝试做一些更有挑战的事情,比如: | ||
|
|
||
| - 修复缺陷,可以先从 [Good-first issue](https://github.com/opentiny/tiny-cli/labels/good%20first%20issue) 开始 | ||
| - 实现新特性 | ||
| - 完善单元测试 | ||
| - 翻译文档 | ||
| - 参与代码检视 | ||
|
|
||
| ## 提交 Issue | ||
|
|
||
| 如果你在使用 TinyCLI 组件过程中遇到问题,欢迎给我们提交 Issue,提交 Issue 之前,请先仔细阅读相关的[官方文档](https://opentiny.design),确认这是一个缺陷还是尚未实现的功能。 | ||
|
|
||
| 如果是一个缺陷,创建新 Issue 时选择 [Bug report](https://github.com/opentiny/tiny-cli/issues/new?template=bug-report.yml) 模板,标题遵循 `[toolkitName/pluginName/CliCore]缺陷简述` 的格式,比如:`[tiny-toolkit-xxx] xxx套件执行tiny start命令启动后提示xxx错误`。 | ||
|
|
||
| 报告缺陷的 Issue 主要需要填写以下信息: | ||
| - tiny-cli 和 node 的版本号 | ||
| - 缺陷的表现,可截图辅助说明,如果有报错可贴上报错信息 | ||
| - 缺陷的复现步骤,最好能提供一个最小可复现 demo 链接 | ||
|
|
||
| 如果是一个新特性,则选择 [Feature request](https://github.com/opentiny/tiny-cli/issues/new?template=feature-request.yml) 模板,标题遵循 `[toolkitName/pluginName/CliCore]新特性简述` 的格式,比如:`[CliCore] 新增switch命令支持切换NPM源功能`。 | ||
|
|
||
| 新特性的 Issue 主要需要填写以下信息: | ||
| - 该特性主要解决用户的什么问题 | ||
| - 该特性的 api 是什么样的 | ||
|
|
||
| ## 提交 PR | ||
|
|
||
| 提交 PR 之前,请先确保你提交的内容是符合 TinyCLI 整体规划的,一般已经标记为 [bug](https://github.com/opentiny/tiny-cli/labels/bug) 的 Issue 是鼓励提交 PR 的,如果你不是很确定,可以创建一个 [Discussion](https://github.com/opentiny/tiny-cli/discussions) 进行讨论。 | ||
|
|
||
| 本地启动步骤: | ||
|
|
||
| - 点击 [TinyCLI](https://github.com/opentiny/tiny-cli) 代码仓库右上角的 Fork 按钮,将上游仓库 Fork 到个人仓库 | ||
| - Clone 个人仓库到本地 | ||
| - 在 Tiny CLI 根目录下运行 npm init, 安装依赖 | ||
| - 运行 npm run dev,启动本地代码编译开发 | ||
|
|
||
| ```shell | ||
| # username 为用户名,执行前请替换 | ||
| git clone git@github.com:username/tiny-cli.git | ||
| cd tiny-cli | ||
| git remote add upstream git@github.com:opentiny/tiny-cli.git | ||
| npm i | ||
|
|
||
| # 启动项目 | ||
| npm run dev | ||
| ``` | ||
|
|
||
| 提交 PR 的步骤: | ||
|
|
||
| - 创建新分支 `git checkout -b username/feature1`,分支名字建议为 `username/feat-xxx` / `username/fix-xxx` | ||
| - 本地编码 | ||
| - 遵循 Commit Message Format 规范进行提交,不符合提交规范的 PR 将不会被合并 | ||
| - 提交到远程仓库:git push origin branchName | ||
| - (可选)同步上游仓库 dev 分支最新代码:git pull upstream dev | ||
| - 打开 TinyCLI 代码仓库的 [Pull requests](https://github.com/opentiny/tiny-cli/pulls) 链接,点击 New pull request 按钮提交 PR | ||
| - 项目 Committer 进行 Code Review,并提出意见 | ||
| - PR 作者根据意见调整代码,请注意一个分支发起了 PR 后,后续的 commit 会自动同步,无需重新提交 PR | ||
| - 项目管理员合并 PR | ||
|
|
||
| 贡献流程结束,感谢你的贡献! | ||
|
|
||
| ## 加入开源社区 | ||
|
|
||
| 如果你对我们的开源项目感兴趣,欢迎通过以下方式加入我们的开源社区。 | ||
|
|
||
| - 添加官方小助手微信:opentiny-official,加入我们的技术交流群 | ||
| - 加入邮件列表:opentiny@googlegroups.com |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.