Skip to content

Commit 486b061

Browse files
committed
🚚 CONTRIBUTING.md 改为英文版,中文版移到 docs/CONTRIBUTING_ZH.md
- 顶层 CONTRIBUTING.md 默认呈现英文(贴合 GitHub 国际化展示约定) - 中文版本 docs/CONTRIBUTING_ZH.md,俄文版本 docs/CONTRIBUTING_RU.md - 修正三份 CONTRIBUTING 顶部互链;同步 README 各语言版本中的链接指向
1 parent 9d47a09 commit 486b061

8 files changed

Lines changed: 154 additions & 154 deletions

File tree

CONTRIBUTING.md

Lines changed: 38 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,111 +1,103 @@
1-
[English Contribution Guidelines](./docs/CONTRIBUTING_EN.md) [Руководство на русском](./docs/CONTRIBUTING_RU.md)
1+
[中文贡献指南](./docs/CONTRIBUTING_ZH.md) / [Руководство на русском](./docs/CONTRIBUTING_RU.md)
22

3-
# ScriptCat 贡献指南
3+
# ScriptCat Contributing Guide
44

5-
我们非常感谢你为 ScriptCat 做出贡献!本指南旨在帮助你以更规范的方式向 ScriptCat 提交贡献,因此请务必认真阅读。
5+
We greatly appreciate your contributions to ScriptCat! This guide aims to help you contribute to ScriptCat in a more standardized way, so please read it carefully.
66

7-
## 提交 Issue
7+
## Submitting Issues
88

9-
在提交 Issue 前,我们建议你先查看 [已有的 Issues](https://github.com/scriptscat/scriptcat/issues),以避免重复提交。
9+
Before submitting an issue, we recommend that you first check the [existing Issues](https://github.com/scriptscat/scriptcat/issues) to avoid duplicate submissions.
1010

11-
### 报告问题、故障与漏洞
11+
### Reporting Problems, Bugs & Vulnerabilities
1212

13-
ScriptCat 是一个不断发展的项目。如果你在使用过程中发现问题,并且确信这些问题是由 ScriptCat 引起的,欢迎提交 Issue。在提交时,请附带详细的复现步骤和运行环境信息。
13+
ScriptCat is an evolving project. If you encounter problems during use and are confident that these issues are caused by ScriptCat, we welcome you to submit an Issue. When submitting, please include detailed reproduction steps and runtime environment information.
1414

15-
### 提出新功能
15+
### Proposing New Features
1616

17-
我们欢迎你在 Issue 中提出新的功能建议。为了让我们更好地理解你的需求,建议你尽可能详细地描述这个功能,并提供你认为可能的解决方案。
17+
We welcome you to propose new feature suggestions in Issues. To help us better understand your needs, we recommend that you describe the feature in as much detail as possible and provide what you think might be a possible solution.
1818

1919
## Pull Request
2020

21-
ScriptCat 使用 [pnpm](https://pnpm.io/) 来管理项目依赖。如果你已经安装了npm,以下的命令可以帮助你快速配置开发环境:
21+
ScriptCat uses [pnpm](https://pnpm.io/) to manage project dependencies. If you already have npm installed, the following commands can help you quickly set up the development environment:
2222

2323
```bash
24-
# 安装 node.js 依赖
24+
# Install node.js dependencies
2525
pnpm install
2626
```
2727

28-
我们推荐使用[代理](https://pnpm.io/npmrc#https-proxy)来解决 pnpm 的网络问题,而不是使用镜像。
28+
We recommend using a [proxy](https://pnpm.io/npmrc#https-proxy) to solve pnpm network issues rather than using mirrors.
2929

3030
```bash
3131
pnpm config set proxy http://127.0.0.1:7890
3232
pnpm config set https-proxy https://127.0.0.1:7890
3333
```
3434

35-
### Commit 规范
35+
### Commit Guidelines
3636

37-
我们希望每一个 commit 都能清晰地描述其目的,每个 commit 应尽可能只包含一个修改。我们的 commit message 格式遵循
38-
[gitmoji](https://gitmoji.dev/) 规范。例如:
37+
We hope that each commit can clearly describe its purpose, and each commit should ideally contain only one modification. Our commit message format follows the [gitmoji](https://gitmoji.dev/) specification. For example:
3938

4039
```bash
4140
git commit -m "✨ add login feature"
4241
```
4342

44-
这个示例表示添加了新的功能:登录功能。
43+
This example indicates that a new feature has been added: login functionality.
4544

46-
### 工作流概述
45+
### Workflow Overview
4746

48-
`main` 分支是 ScriptCat 的主分支。为了保持代码的完整性,请不要直接修改 `main`
49-
分支。你应该创建一个新的分支,并在这个分支上进行修改,然后发起一个目标分支为
50-
`main` 的 Pull Request。Pull Request
51-
的标题请尽量使用中文,以便于自动生成更新日志。
47+
The `main` branch is ScriptCat's primary branch. To maintain code integrity, please do not directly modify the `main` branch. You should create a new branch and make modifications on this branch, then initiate a Pull Request targeting the `main` branch. Please try to use Chinese for Pull Request titles to facilitate automatic changelog generation.
5248

53-
如果你不是 ScriptCat 团队的成员,你可以先 fork 本仓库,然后向本仓库的 `main`
54-
分支发起 Pull Request。在创建 commit 时,请按照上述 commit message
55-
规范进行。我们将在 code review 完成后将你的贡献合并到主分支。
49+
If you are not a member of the ScriptCat team, you can first fork this repository and then initiate a Pull Request to the `main` branch of this repository. When creating commits, please follow the commit message guidelines mentioned above. We will merge your contributions to the main branch after code review is completed.
5650

57-
## 撰写文档
51+
## Writing Documentation
5852

59-
ScriptCat的文档在另外的仓库中:[scriptcat.org](https://docs.scriptcat.org),使用
60-
[docusaurus](https://docusaurus.io/)进行撰写,这有一些 [Markdown](https://docusaurus.io/zh-CN/docs/markdown-features)
61-
特性可以帮助你。如果你需要在本地预览修改后的文档,可以使用以下命令安装文档依赖并启动dev server:
53+
ScriptCat's documentation is in a separate repository: [scriptcat.org](https://docs.scriptcat.org), written using [docusaurus](https://docusaurus.io/). There are some [Markdown](https://docusaurus.io/zh-CN/docs/markdown-features) features that can help you. If you need to preview the modified documentation locally, you can use the following commands to install documentation dependencies and start the dev server:
6254

6355
```bash
6456
pnpm install
6557
pnpm start
6658
```
6759

68-
### 帮助我们翻译
60+
### Help Us Translate
6961

70-
ScriptCat 的翻译文件托管在 GitHub 上,欢迎通过 Pull Request 贡献翻译。
62+
ScriptCat's translation files are hosted on GitHub. Contributions via Pull Request are welcome.
7163

72-
- 翻译文件位于 [`src/locales`](https://github.com/scriptscat/scriptcat/tree/main/src/locales),每种语言对应一个 `<语言代码>/translation.json`
73-
- **改进已有翻译**:直接编辑对应语言的 `translation.json`
74-
- **新增语言**:在 `src/locales/` 下新建对应语言代码目录(如 `fr-FR`),复制 `en-US/translation.json` 作为模板进行翻译,并在 `src/locales/locales.ts` 中注册
75-
- 完成后向 `main` 分支提交 Pull Request 即可
64+
- Translation files live in [`src/locales`](https://github.com/scriptscat/scriptcat/tree/main/src/locales); each language has its own `<locale>/translation.json`
65+
- **Improve an existing translation**: edit the corresponding `translation.json` directly
66+
- **Add a new language**: create a new directory under `src/locales/` (e.g. `fr-FR`), copy `en-US/translation.json` as a template and translate the strings, then register the locale in `src/locales/locales.ts`
67+
- Open a Pull Request against the `main` branch when you are done
7668

77-
## 参与开发
69+
## Participating in Development
7870

79-
ScriptCat 使用 ESLint 来规范代码风格,使用 Vitest 来进行单元测试。你可以使用以下命令来运行:
71+
ScriptCat uses ESLint to standardize code style and Vitest for unit testing. You can use the following commands to run them:
8072

8173
```bash
8274
pnpm test
8375
pnpm run lint
8476
```
8577

86-
ScriptCat 的页面开发使用了以下技术:
78+
ScriptCat's page development uses the following technologies:
8779

8880
- [React](https://reactjs.org/)
89-
- UI 框架 [arco](https://arco.design)
90-
- CSS 框架 [unocss](https://unocss.dev/interactive/)
91-
- RsPack 打包工具 [rspack](https://rspack.dev/)
81+
- UI framework [arco](https://arco.design)
82+
- CSS framework [unocss](https://unocss.dev/interactive/)
83+
- RsPack bundling tool [rspack](https://rspack.dev/)
9284

93-
如果你想在本地运行 ScriptCat,可以使用以下命令:
85+
If you want to run ScriptCat locally, you can use the following commands:
9486

9587
```bash
9688
pnpm run dev
97-
# 请注意,由于未知原因,如果你需要使用隐身窗口,你需要使用下面的命令进行开发
89+
# Please note that for unknown reasons, if you need to use incognito windows, you need to use the following command for development
9890
pnpm run dev:noMap
9991
```
10092

101-
如果你想打包扩展,可以使用以下命令:
93+
If you want to package the extension, you can use the following command:
10294

10395
```bash
10496
pnpm run pack
10597
```
10698

107-
在打包前,请确保在`dist`目录下生成了`scriptcat.pem`文件。
99+
Before packaging, please ensure that the `scriptcat.pem` file is generated in the `dist` directory.
108100

109-
## 注意问题
101+
## Important Notes
110102

111-
- `pnpm run dev`之后需要把`dist/ext`目录里面内容在浏览器扩展里面导入加载,然后开始改代码保存即可,浏览器是实时更新的,但是涉及到`manifest.json``service_worker``offscreen``sandbox`的改动需要重新加载。
103+
- After running `pnpm run dev`, you need to import and load the contents of the `dist/ext` directory into the browser extension, then start editing code and save. The browser updates in real-time, but changes involving `manifest.json`, `service_worker`, `offscreen`, and `sandbox` require reloading.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ documentation page to make modifications.
102102

103103
## 🤝 Contributing
104104

105-
We welcome all forms of contributions! Please check the [Contributing Guide](./docs/CONTRIBUTING_EN.md) to learn how to
105+
We welcome all forms of contributions! Please check the [Contributing Guide](./CONTRIBUTING.md) to learn how to
106106
get started.
107107

108108
### 💬 Community

README_ja.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ ScriptCat は、Tampermonkey の設計思想に基づく強力なユーザース
9797
## 🤝 コントリビューション
9898

9999
あらゆる形式の貢献を歓迎します!
100-
まずは [Contributing Guide](./docs/CONTRIBUTING_EN.md) をご覧ください。
100+
まずは [Contributing Guide](./CONTRIBUTING.md) をご覧ください。
101101

102102
### 💬 コミュニティ
103103

README_zh-CN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ ScriptCat(脚本猫)是一个功能强大的用户脚本管理器,基于
9393

9494
## 🤝 参与贡献
9595

96-
我们欢迎所有形式的贡献!请查看 [贡献指南](./CONTRIBUTING.md) 了解如何开始。
96+
我们欢迎所有形式的贡献!请查看 [贡献指南](./docs/CONTRIBUTING_ZH.md) 了解如何开始。
9797

9898
### 💬 社区交流
9999

README_zh-TW.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ ScriptCat 是一款基於 Tampermonkey 設計理念的強大使用者腳本管
9797
## 🤝 參與貢獻
9898

9999
我們歡迎各種形式的貢獻!
100-
請參考 [貢獻指南](./docs/CONTRIBUTING_EN.md) 了解如何開始。
100+
請參考 [貢獻指南](./CONTRIBUTING.md) 了解如何開始。
101101

102102
### 💬 社群
103103

docs/CONTRIBUTING_EN.md

Lines changed: 0 additions & 103 deletions
This file was deleted.

docs/CONTRIBUTING_RU.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[中文](CONTRIBUTING.md) / [English](./docs/CONTRIBUTING_EN.md) / Русский
1+
[English](../CONTRIBUTING.md) / [中文](./CONTRIBUTING_ZH.md) / Русский
22

33
# Руководство по внесению вклада в ScriptCat
44

0 commit comments

Comments
 (0)