Update documentation to use '存储库' instead of '项目'
Replaced occurrences of '项目' (project) with '存储库' (repository) across issue templates, contributing guide, and README for consistency and clarity. Updated badges, usage examples, and contribution instructions to reflect this terminology change. No functional code changes were made.
This commit is contained in:
xixu-me committed
1 parent
d79a50a716
commit
4d9a26454f
10 files changed
+4811
-3077
No files matched your search
@@ -140,7 +140,7 @@ body:
|
||||
options:
|
||||
- label: 我已经搜索了现有的 issues，确认这不是重复报告
|
||||
required: true
|
||||
- label: 我已经阅读了项目文档和故障排除指南
|
||||
- label: 我已经阅读了存储库文档和故障排除指南
|
||||
required: true
|
||||
- label: 我提供的信息准确且完整
|
||||
required: true
|
||||
@@ -1,8 +1,8 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: 📚 项目文档
|
||||
- name: 📚 存储库文档
|
||||
url: https://github.com/xixu-me/Xget/blob/main/README.md
|
||||
about: 查看完整的项目文档和使用指南
|
||||
about: 查看完整的存储库文档和使用指南
|
||||
- name: 💬 讨论区
|
||||
url: https://github.com/xixu-me/Xget/discussions
|
||||
about: 参与社区讨论，分享使用经验和最佳实践
|
||||
|
||||
@@ -193,7 +193,7 @@ body:
|
||||
label: 确认
|
||||
description: 在提交之前，请确认以下内容
|
||||
options:
|
||||
- label: 我已经阅读了项目的 README 和部署文档
|
||||
- label: 我已经阅读了存储库的 README 和部署文档
|
||||
required: true
|
||||
- label: 我已经搜索了现有的 issues 寻找类似问题
|
||||
required: true
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
name: ✨ 功能请求
|
||||
description: 为这个项目建议一个想法
|
||||
description: 为这个存储库建议一个想法
|
||||
title: "[FEATURE] "
|
||||
labels: ["enhancement", "需要分类"]
|
||||
assignees: []
|
||||
@@ -125,7 +125,7 @@ body:
|
||||
options:
|
||||
- label: 我已经搜索了现有的 issues，确认这不是重复请求
|
||||
required: true
|
||||
- label: 我已经阅读了项目文档，确认此功能尚未存在
|
||||
- label: 我已经阅读了存储库文档，确认此功能尚未存在
|
||||
required: true
|
||||
- label: 这个功能符合项目的目标和范围
|
||||
- label: 这个功能符合存储库的目标和范围
|
||||
required: true
|
||||
@@ -92,7 +92,7 @@
|
||||
|
||||
### 代码质量
|
||||
|
||||
- [ ] 代码遵循项目编码规范
|
||||
- [ ] 代码遵循存储库编码规范
|
||||
- [ ] 添加了必要的注释
|
||||
- [ ] 没有遗留的调试代码
|
||||
- [ ] 处理了所有可能的错误情况
|
||||
|
||||
+7
-27
@@ -1,6 +1,6 @@
|
||||
# 贡献指南
|
||||
|
||||
感谢您对 Xget 项目的关注！我们欢迎各种形式的贡献，包括但不限于代码、文档、测试、反馈和建议。
|
||||
感谢您对 Xget 的关注！我们欢迎各种形式的贡献，包括但不限于代码、文档、测试、反馈和建议。
|
||||
|
||||
## 🤝 贡献方式
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
|
||||
### 提交代码
|
||||
|
||||
- Fork 项目到您的 GitHub 账户
|
||||
- Fork 存储库到您的 GitHub 账户
|
||||
- 创建功能分支 (`git checkout -b feature/amazing-feature`)
|
||||
- 提交更改 (`git commit -m 'Add some amazing feature'`)
|
||||
- 推送到分支 (`git push origin feature/amazing-feature`)
|
||||
@@ -37,7 +37,7 @@
|
||||
### 本地开发
|
||||
|
||||
```bash
|
||||
# 克隆项目
|
||||
# 克隆存储库
|
||||
git clone https://github.com/xixu-me/Xget.git
|
||||
cd Xget
|
||||
|
||||
@@ -57,26 +57,6 @@ npm run format
|
||||
npm run lint
|
||||
```
|
||||
|
||||
### 项目结构
|
||||
|
||||
```
|
||||
Xget/
|
||||
├── src/
|
||||
│ ├── config/ # 配置文件
|
||||
│ │ ├── index.js # 主配置
|
||||
│ │ └── platforms.js # 平台配置
|
||||
│ ├── utils/ # 工具函数
|
||||
│ └── index.js # 主入口文件
|
||||
├── tests/ # 测试文件
|
||||
├── docs/ # 文档
|
||||
├── .github/ # GitHub 配置
|
||||
│ ├── ISSUE_TEMPLATE/ # Issue 模板
|
||||
│ └── workflows/ # CI/CD 工作流
|
||||
├── wrangler.toml # Cloudflare Workers 配置
|
||||
├── package.json
|
||||
└── README.md
|
||||
```
|
||||
|
||||
## 📝 代码规范
|
||||
|
||||
### 代码风格
|
||||
@@ -174,7 +154,7 @@ perf(proxy): optimize request handling performance
|
||||
### 提交前检查
|
||||
|
||||
- [ ] 代码通过所有测试
|
||||
- [ ] 代码符合项目规范
|
||||
- [ ] 代码符合存储库规范
|
||||
- [ ] 添加了必要的测试
|
||||
- [ ] 更新了相关文档
|
||||
- [ ] Commit 消息符合规范
|
||||
@@ -199,7 +179,7 @@ perf(proxy): optimize request handling performance
|
||||
|
||||
- 代码贡献会在 GitHub 贡献图中显示
|
||||
- 重要贡献会在 Release Notes 中特别提及
|
||||
- 长期贡献者可能被邀请成为项目维护者
|
||||
- 长期贡献者可能被邀请成为存储库维护者
|
||||
|
||||
## 📋 开发任务
|
||||
|
||||
@@ -240,11 +220,11 @@ A: 检查 CORS 配置，确保允许的源和方法设置正确。
|
||||
|
||||
## 📄 许可证
|
||||
|
||||
通过贡献代码，您同意您的贡献将在与项目相同的 [GPL-3.0 许可证](LICENSE) 下发布。
|
||||
通过贡献代码，您同意您的贡献将在与存储库相同的 [GPL-3.0 许可证](LICENSE) 下发布。
|
||||
|
||||
## 🙏 致谢
|
||||
|
||||
感谢所有为 Xget 项目做出贡献的开发者、测试者和用户。您的支持和反馈是项目持续改进的动力！
|
||||
感谢所有为 Xget 做出贡献的开发者、测试者和用户。您的支持和反馈是存储库持续改进的动力！
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,10 +1,15 @@
|
||||
# Xget
|
||||
|
||||
[](#cloudflare-workers-一键部署)
|
||||
|
||||
[](#github)
|
||||
[](#gitlab)
|
||||
[](#hugging-face)
|
||||
[](#cloudflare-workers-一键部署)
|
||||
[](#-生态系统集成)
|
||||
[](#npm-包管理加速)
|
||||
[](#python-包管理加速)
|
||||
[](#conda-包管理加速)
|
||||
|
||||
[](https://github.com/xixu-me/Xget-for-Chromium)
|
||||
|
||||
一个高性能、安全的代理服务，专为加速 GitHub、GitLab、Hugging Face、npm、PyPI 和 conda 的文件下载和 Git 操作而设计。
|
||||
|
||||
@@ -68,7 +73,7 @@
|
||||
- 检测 Git 客户端 User-Agent 模式
|
||||
- 支持 `service=git-upload-pack` 等查询参数
|
||||
- **完整操作支持**：
|
||||
- `git clone`：完整仓库克隆，支持浅克隆和分支指定
|
||||
- `git clone`：完整存储库克隆，支持浅克隆和分支指定
|
||||
- `git push`：代码推送和分支管理
|
||||
- `git pull/fetch`：增量更新和远程同步
|
||||
- `git submodule`：子模块递归克隆
|
||||
@@ -122,7 +127,7 @@
|
||||
|
||||
3. **自定义配置（可选）**
|
||||
|
||||
编辑 `wrangler.toml` 文件设置你的项目名称：
|
||||
编辑 `wrangler.toml` 文件设置你的存储库名称：
|
||||
|
||||
```toml
|
||||
name = "你的-xget-项目名"
|
||||
@@ -244,7 +249,7 @@ https://xget.xi-xu.me/conda/community/conda-forge/linux-64/repodata.json
|
||||
Xget 完全兼容 Git 协议，支持所有标准 Git 操作：
|
||||
|
||||
```bash
|
||||
# 克隆仓库
|
||||
# 克隆存储库
|
||||
git clone https://xget.xi-xu.me/gh/microsoft/vscode.git
|
||||
|
||||
# 克隆指定分支
|
||||
@@ -253,14 +258,14 @@ git clone -b main https://xget.xi-xu.me/gh/facebook/react.git
|
||||
# 浅克隆（仅最新提交）
|
||||
git clone --depth 1 https://xget.xi-xu.me/gh/torvalds/linux.git
|
||||
|
||||
# 添加远程仓库
|
||||
git remote add upstream https://xget.xi-xu.me/gh/[用户名]/[仓库名].git
|
||||
# 添加远程存储库
|
||||
git remote add upstream https://xget.xi-xu.me/gh/[所有者]/[存储库].git
|
||||
|
||||
# 拉取更新
|
||||
git pull https://xget.xi-xu.me/gh/microsoft/vscode.git main
|
||||
|
||||
# 子模块递归克隆
|
||||
git clone --recursive https://xget.xi-xu.me/gh/[用户名]/[带子模块的仓库].git
|
||||
git clone --recursive https://xget.xi-xu.me/gh/[用户名]/[带子模块的存储库].git
|
||||
```
|
||||
|
||||
### 主流下载工具集成
|
||||
@@ -537,13 +542,13 @@ jobs:
|
||||
- name: Clone dependency repo
|
||||
run: |
|
||||
# 使用 Xget 加速 Git 克隆
|
||||
git clone https://xget.xi-xu.me/gh/[依赖项目]/[仓库名].git
|
||||
git clone https://xget.xi-xu.me/gh/[所有者]/[存储库].git
|
||||
|
||||
- name: Download release assets
|
||||
run: |
|
||||
# 批量下载发布文件
|
||||
curl -L -O https://xget.xi-xu.me/gh/[项目名]/releases/download/v1.0.0/[文件名].tar.gz
|
||||
curl -L -O https://xget.xi-xu.me/gh/[项目名]/releases/download/v1.0.0/[文件名].zip
|
||||
curl -L -O https://xget.xi-xu.me/gh/[所有者]/[存储库]/releases/download/v1.0.0/[文件名].tar.gz
|
||||
curl -L -O https://xget.xi-xu.me/gh/[所有者]/[存储库]/releases/download/v1.0.0/[文件名].zip
|
||||
```
|
||||
|
||||
#### GitLab CI
|
||||
@@ -558,7 +563,7 @@ download_dependencies:
|
||||
script:
|
||||
# 使用 Xget 加速下载
|
||||
- wget https://xget.xi-xu.me/gl/gitlab-org/gitlab-runner/-/archive/main/gitlab-runner-main.zip
|
||||
- git clone https://xget.xi-xu.me/gh/[外部项目]/[依赖仓库].git
|
||||
- git clone https://xget.xi-xu.me/gh/[所有者]/[依赖存储库].git
|
||||
# 下载 Hugging Face 数据集
|
||||
- curl -L -O https://xget.xi-xu.me/hf/datasets/wikitext/resolve/main/wikitext-103-v1/wiki.train.tokens
|
||||
artifacts:
|
||||
@@ -580,7 +585,7 @@ RUN apt-get update && apt-get install -y wget curl git
|
||||
RUN wget https://xget.xi-xu.me/gh/microsoft/vscode/archive/refs/heads/main.zip
|
||||
|
||||
# 克隆源码
|
||||
RUN git clone https://xget.xi-xu.me/gh/[项目名]/[源码仓库].git /app
|
||||
RUN git clone https://xget.xi-xu.me/gh/[所有者]/[源码存储库].git /app
|
||||
|
||||
# 下载模型文件
|
||||
RUN curl -L -o /models/model.bin https://xget.xi-xu.me/hf/microsoft/DialoGPT-medium/resolve/main/pytorch_model.bin
|
||||
@@ -619,7 +624,7 @@ export const CONFIG = {
|
||||
|
||||
### 性能调优建议
|
||||
|
||||
- **缓存优化**：根据使用模式调整 `CACHE_DURATION`，频繁更新的仓库可适当降低
|
||||
- **缓存优化**：根据使用模式调整 `CACHE_DURATION`，频繁更新的存储库可适当降低
|
||||
- **超时设置**：网络条件较差时可适当增加 `TIMEOUT_SECONDS`
|
||||
- **重试策略**：高延迟环境下可增加 `MAX_RETRIES` 和 `RETRY_DELAY_MS`
|
||||
|
||||
@@ -641,7 +646,7 @@ export const PLATFORMS = {
|
||||
|
||||
## 🚧 开发
|
||||
|
||||
1. **项目设置**
|
||||
1. **存储库设置**
|
||||
|
||||
```bash
|
||||
git clone https://github.com/xixu-me/Xget.git
|
||||
@@ -663,7 +668,7 @@ export const PLATFORMS = {
|
||||
|
||||
## 🧪 测试
|
||||
|
||||
项目包含完整的测试套件，确保代码质量和功能正确性。
|
||||
存储库包含完整的测试套件，确保代码质量和功能正确性。
|
||||
|
||||
### 完整测试
|
||||
|
||||
@@ -721,7 +726,7 @@ npx wrangler dev --log-level debug
|
||||
|
||||
## ⚠️ 免责声明
|
||||
|
||||
- **合法使用**：本项目仅用于加速合法的公开文件下载和 Git 操作，请遵守相关平台的使用条款和当地法律法规
|
||||
- **合法使用**：本存储库仅用于加速合法的公开文件下载和 Git 操作，请遵守相关平台的使用条款和当地法律法规
|
||||
- **服务可用性**：公共实例 `xget.xi-xu.me` 为免费服务，不保证 100% 可用性，建议生产环境部署自己的实例
|
||||
- **数据安全**：虽然 Xget 不存储或记录用户数据，但请谨慎处理敏感信息的下载
|
||||
- **责任限制**：使用本服务造成的任何直接或间接损失，开发者不承担责任
|
||||
@@ -729,19 +734,19 @@ npx wrangler dev --log-level debug
|
||||
|
||||
## 🤝 贡献
|
||||
|
||||
我们欢迎各种形式的贡献！请查看 [贡献指南](CONTRIBUTING.md) 了解如何参与项目开发。
|
||||
我们欢迎各种形式的贡献！请查看 [贡献指南](CONTRIBUTING.md) 了解如何参与存储库开发。
|
||||
|
||||
### 快速开始贡献
|
||||
|
||||
1. **报告问题**: 使用 [Issue 模板](https://github.com/xixu-me/Xget/issues/new/choose) 报告 bug 或提出功能请求
|
||||
2. **提交代码**: Fork 项目，创建功能分支，提交 Pull Request
|
||||
2. **提交代码**: Fork 存储库，创建功能分支，提交 Pull Request
|
||||
3. **改进文档**: 修正错误、添加示例、完善说明
|
||||
4. **测试反馈**: 在不同环境下测试并提供反馈
|
||||
|
||||
### 开发环境
|
||||
|
||||
```bash
|
||||
# 克隆项目
|
||||
# 克隆存储库
|
||||
git clone https://github.com/xixu-me/Xget.git
|
||||
cd Xget
|
||||
|
||||
@@ -761,7 +766,7 @@ npm test
|
||||
|
||||
## 🔗 相关链接
|
||||
|
||||
- **项目主页**: [GitHub Repository](https://github.com/xixu-me/Xget)
|
||||
- **存储库主页**: [GitHub Repository](https://github.com/xixu-me/Xget)
|
||||
- **公共实例**: [xget.xi-xu.me](https://xget.xi-xu.me)
|
||||
- **浏览器扩展**: [Xget for Chromium](https://github.com/xixu-me/Xget-for-Chromium)
|
||||
- **问题反馈**: [GitHub Issues](https://github.com/xixu-me/Xget/issues)
|
||||
@@ -780,7 +785,7 @@ npm test
|
||||
|
||||
<div align="center">
|
||||
|
||||
**如果这个项目对您有帮助，请考虑给它一个 ⭐ Star！**
|
||||
**如果这个存储库对您有帮助，请考虑给它一个 ⭐ Star！**
|
||||
|
||||
Made with ❤️ by [Xi Xu](https://xi-xu.me)
|
||||
|
||||
|
||||
Generated
+4765
-2996
File diff suppressed because it is too large.
Load diff
+3
-23
@@ -1,26 +1,6 @@
|
||||
# Xget 测试文档
|
||||
|
||||
本目录包含 Xget 项目的完整测试套件，涵盖单元测试、集成测试、性能测试和安全测试。
|
||||
|
||||
## 📁 目录结构
|
||||
|
||||
```
|
||||
test/
|
||||
├── benchmark/ # 性能基准测试
|
||||
│ └── performance.bench.js
|
||||
├── fixtures/ # 测试数据和模拟响应
|
||||
│ └── responses.js
|
||||
├── helpers/ # 测试工具和辅助函数
|
||||
│ └── test-utils.js
|
||||
├── index.test.js # 核心功能测试
|
||||
├── integration.test.js # 集成测试
|
||||
├── performance.test.js # 性能监控测试
|
||||
├── platforms.test.js # 平台配置测试
|
||||
├── security.test.js # 安全功能测试
|
||||
├── utils.test.js # 工具函数测试
|
||||
├── setup.js # 测试环境设置
|
||||
└── README.md # 本文档
|
||||
```
|
||||
本目录包含 Xget 的完整测试套件，涵盖单元测试、集成测试、性能测试和安全测试。
|
||||
|
||||
## 🚀 运行测试
|
||||
|
||||
@@ -126,7 +106,7 @@ const response = createMockResponse(MOCK_RESPONSES.github.packageJson);
|
||||
|
||||
## 📊 测试覆盖率
|
||||
|
||||
项目设置了以下覆盖率目标：
|
||||
存储库设置了以下覆盖率目标：
|
||||
|
||||
- **分支覆盖率**: 80%
|
||||
- **函数覆盖率**: 80%
|
||||
@@ -353,7 +333,7 @@ it('应该包含所有安全头', async () => {
|
||||
|
||||
1. 确定测试类型和位置
|
||||
2. 使用现有的测试工具
|
||||
3. 遵循项目的测试风格
|
||||
3. 遵循存储库的测试风格
|
||||
4. 确保测试通过且有意义
|
||||
|
||||
### 修复测试
|
||||
|
||||
@@ -138,7 +138,7 @@ describe('Security Features', () => {
|
||||
|
||||
it('should handle Unicode characters safely', async () => {
|
||||
const unicodePaths = [
|
||||
'/gh/用户/仓库/文件.txt',
|
||||
'/gh/所有者/存储库/文件.txt',
|
||||
'/gh/user/repo/файл.txt',
|
||||
'/gh/user/repo/ファイル.txt'
|
||||
];
|
||||
|
||||
Reference in new issue
Block a user