code-review

Files (2)

• LICENSE.txt
• SKILL.md

SKILL.md (first lines)

# 科研代码审查助手

帮助科研人员系统化地审查代码，确保研究代码的质量、正确性和可重复性。

## 核心原则

### 科研代码审查的四个维度

1. **正确性** - 代码是否正确实现了研究方法
2. **可重复性** - 他人能否复现研究结果
3. **可维护性** - 代码是否清晰、有文档、易于理解
4. **数据完整性** - 数据处理是否安全、准确

## 审查流程

### 第一阶段：预审查准备

在开始代码审查前，收集必要信息：

```markdown
## 代码审查准备清单

### 基本信息
- [ ] 代码用途和研究目标
- [ ] 预期输入和输出
- [ ] 使用的数据集和数据格式
- [ ] 依赖的软件包和版本
- [ ] 已知的限制和假设

### 审查范围
- [ ] 需要审查的文件列表
- [ ] 关键函数和模块
- [ ] 测试覆盖情况
- [ ] 文档完整性

### 参考材料
- [ ] 相关论文和方法描述
- [ ] 现有测试和验证
- [ ] 以前的审查反馈
```

### 第二阶段：代码结构审查

#### 项目组织

```python
# 检查项目结构是否清晰
def check_project_structure():
    """
    理想的科研项目结构：

    project/
    ├── README.md              # 项目说明
    ├── requirements.txt       # 依赖列表
    ├── environment.yml        # Conda环境
    ├── data/                  # 数据目录
    │   ├── raw/              # 原始数据
    │   ├── processed/        # 处理后数据
    │   └── README.md         # 数据说明
    ├── src/                   # 源代码
    │   ├── __init__.py
    │   ├── preprocessing.py
    │   ├── analysis.py
    │   └── visualization.py
    ├── notebooks/             # Jupyter notebooks
    ├── tests/                 # 测试代码
    ├── scripts/               # 运行脚本
    ├── results/               # 结果输出
    └── docs/                  # 文档
    """
    pass
```

**审查要点：**
- [ ] 目录结构清晰合理
- [ ] README 文件完整
- [ ] 数据和代码分离
- [ ] 结果和代码分离
- [ ] 有适当的 .gitignore

#### 代码模块化

```python
# 反模式：所有代码在一个文件中
# ❌ BAD
def analysis():
    # 1000+ 行代码在一个函数中
    data = load_data()
    # ... 大量处理逻辑
    plot_results()

# 最佳实践：模块化和单一职责
# ✅ GOOD
from src.data import load_data, preprocess_data
from src.analysis import run_statistical_test
from src.visualization import plot_results

def main():
    """主分析流程"""
    # 步骤1: 加载数据
    raw_data = load_data('data/raw/experiment.csv')

    # 步骤2: 预处理
    clean_data = preprocess_data(raw_data)

    # 步骤3: 统计分析
    results = run_statistical_test(clean_data)

    # 步骤4: 可视化
    plot_results(results, output='results/figures/')

    return results
```

**审查要点：**
- [ ] 函数职责单一（每个函数做一件事）
- [ ] 函数长度合理（< 50 行）
- [ ] 避免重复代码（DRY原则）
- [ ] 适当的抽象层次

From Hollis36/claude-skill, Apache-2.0.

More from Hollis36/claude-skill