oss-ready

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Workflow

工作流程

0. Create Feature Branch

0. 创建功能分支

Before making any changes:

Check the current branch - if already on a feature branch for this task, skip
Check the repo for branch naming conventions (e.g.,
```
feat/
```
,
```
feature/
```
, etc.)
Create and switch to a new branch following the repo's convention, or fallback to:
```
feat/oss-ready
```

在进行任何更改之前：

检查当前分支 - 如果已处于该任务对应的功能分支，可跳过此步骤
查看仓库的分支命名规范（例如：
```
feat/
```
、
```
feature/
```
等）
按照仓库规范创建并切换到新分支，若无规范则使用默认分支名：
```
feat/oss-ready
```

1. Analyze Project

1. 分析项目

Identify:

Primary language(s) and tech stack
Project purpose and functionality
Existing documentation to preserve
Package manager (npm, pip, cargo, etc.)

确定以下内容：

主要编程语言及技术栈
项目用途与功能
需要保留的现有文档
包管理器（npm、pip、cargo等）

2. Create/Update Core Files

2. 创建/更新核心文件

README.md - Enhance with:

Project overview and motivation
Key features list
Quick start (< 5 min setup)
Prerequisites and installation
Usage examples with code
Project structure
Technology stack
Contributing link
License badge

CONTRIBUTING.md - Include:

How to contribute overview
Development setup
Branching strategy (feature branches from main)
Commit conventions (Conventional Commits)
PR process and review expectations
Coding standards
Testing requirements

LICENSE - Default to MIT unless specified. Copy from

assets/LICENSE-MIT

CODE_OF_CONDUCT.md - Use Contributor Covenant. Copy from

assets/CODE_OF_CONDUCT.md

SECURITY.md - Vulnerability reporting process. Copy from

assets/SECURITY.md

README.md - 补充以下内容：

项目概述与开发动机
核心功能列表
快速上手（5分钟内完成配置）
前置条件与安装步骤
含代码示例的使用说明
项目结构
技术栈
贡献指南链接
许可证徽章

CONTRIBUTING.md - 包含以下内容：

贡献方式概述
开发环境配置
分支策略（从主分支创建功能分支）
提交规范（Conventional Commits）
PR流程与审核要求
编码标准
测试要求

LICENSE - 除非另有指定，默认使用MIT许可证。从

assets/LICENSE-MIT

复制内容。

CODE_OF_CONDUCT.md - 使用Contributor Covenant模板。从

assets/CODE_OF_CONDUCT.md

复制内容。

SECURITY.md - 漏洞上报流程。从

assets/SECURITY.md

复制内容。

3. Create GitHub Templates

3. 创建GitHub模板

Copy from

assets/.github/

```
ISSUE_TEMPLATE/bug_report.md
```
```
ISSUE_TEMPLATE/feature_request.md
```
```
PULL_REQUEST_TEMPLATE.md
```

从

assets/.github/

复制以下模板：

```
ISSUE_TEMPLATE/bug_report.md
```
```
ISSUE_TEMPLATE/feature_request.md
```
```
PULL_REQUEST_TEMPLATE.md
```

4. Create Documentation Structure

4. 创建文档结构

docs/
├── ARCHITECTURE.md    # System design, components
├── DEVELOPMENT.md     # Dev setup, debugging
├── DEPLOYMENT.md      # Production deployment
└── CHANGELOG.md       # Version history

docs/
├── ARCHITECTURE.md    # 系统设计、组件
├── DEVELOPMENT.md     # 开发环境配置、调试
├── DEPLOYMENT.md      # 生产环境部署
└── CHANGELOG.md       # 版本历史

5. Update Project Metadata

5. 更新项目元数据

Update package file based on tech stack:

Node.js:
```
package.json
```
- name, description, keywords, repository, license
Python:
```
pyproject.toml
```
or
```
setup.py
```
Rust:
```
Cargo.toml
```
Go:
```
go.mod
```
+ README badges

根据技术栈更新包管理文件：

Node.js：
```
package.json
```
- 名称、描述、关键词、仓库地址、许可证
Python：
```
pyproject.toml
```
或
```
setup.py
```
Rust：
```
Cargo.toml
```
Go：
```
go.mod
```
+ README徽章

6. Ensure .gitignore

6. 检查.gitignore文件

Verify comprehensive patterns for the tech stack.

确保文件包含对应技术栈的完整忽略规则。

7. Present Checklist

7. 展示检查清单

After completion, show:

Files created/updated
Items needing manual review
Recommendations for next steps

完成所有步骤后，展示以下内容：

已创建/更新的文件
需要人工审核的项
后续步骤建议

Guidelines

指南

Preserve existing content - enhance, don't replace
Use professional, welcoming tone
Adapt to project's actual tech stack
Include working examples from the actual codebase

保留现有内容 - 仅做增强，不替换
使用专业且友好的语气
适配项目实际使用的技术栈
包含来自项目代码库的可运行示例

Assets

资源文件

Templates in

assets/

```
LICENSE-MIT
```
- MIT license template
```
CODE_OF_CONDUCT.md
```
- Contributor Covenant
```
SECURITY.md
```
- Security policy template
```
.github/ISSUE_TEMPLATE/bug_report.md
```

.github/ISSUE_TEMPLATE/feature_request.md

```
.github/PULL_REQUEST_TEMPLATE.md
```

assets/

目录下的模板：

```
LICENSE-MIT
```
- MIT许可证模板
```
CODE_OF_CONDUCT.md
```
- Contributor Covenant行为准则模板
```
SECURITY.md
```
- 安全政策模板
```
.github/ISSUE_TEMPLATE/bug_report.md
```

.github/ISSUE_TEMPLATE/feature_request.md

```
.github/PULL_REQUEST_TEMPLATE.md
```