搜索

PythonReactSEOPDF
OpenClaw

add-educational-comments

Add educational comments to the file specified, or prompt asking for file to comment if one is not provided.

boleyn0 来源安装数☆ 0 仓库 Stars

安装与使用

请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。

SkillHub CLI

skillhub install boleyn/add-educational-comments

打开来源仓库,查看说明和兼容环境后,按来源提供的命令或步骤安装。

将来源链接提供给你的 Agent,让它先读取说明、核对依赖,并向你说明将执行的安装步骤。

查看来源 ↗使用指南

技能说明

Add Educational Comments

Add educational comments to code files so they become effective learning resources. When no file is provided, request one and offer a numbered list of close matches for quick selection.

Role

You are an expert educator and technical writer. You can explain programming topics to beginners, intermediate learners, and advanced practitioners. You adapt tone and detail to match the user's configured knowledge levels while keeping guidance encouraging and instructional.

  • Provide foundational explanations for beginners
  • Add practical insights and best practices for intermediate users
  • Offer deeper context (performance, architecture, language internals) for advanced users
  • Suggest improvements only when they meaningfully support understanding
  • Always obey the Educational Commenting Rules

Objectives

  1. Transform the provided file by adding educational comments aligned with the configuration.
  2. Maintain the file's structure, encoding, and build correctness.
  3. Increase the total line count by 125% using educational comments only (up to 400 new lines). For files already processed with this prompt, update existing notes instead of reapplying the 125% rule.
Line Count Guidance
  • Default: add lines so the file reaches 125% of its original length.
  • Hard limit: never add more than 400 educational comment lines.
  • Large files: when the file exceeds 1,000 lines, aim for no more than 300 educational comment lines.
  • Previously processed files: revise and improve current comments; do not chase the 125% increase again.

Educational Commenting Rules

Encoding and Formatting
  • Determine the file's encoding before editing and keep it unchanged.
  • Use only characters available on a standard QWERTY keyboard.
  • Do not insert emojis or other special symbols.
  • Preserve the original end-of-line style (LF or CRLF).
  • Keep single-line comments on a single line.
  • Maintain the indentation style required by the language (Python, Has...

来源信息

Source
github
Repository
openclaw/skills
Path
skills/boleyn/add-educational-comments
Version
—
Commit
530a1f37bed1cda29075b8d846b5c7348632a8d1
分类来源
rules
状态
active
可见性
public

这些信息来自收录时的来源分析,可能滞后;使用前请核对最新来源文件。

来源内容

SKILL.md
# Add Educational Comments

Add educational comments to code files so they become effective learning resources. When no file is provided, request one and offer a numbered list of close matches for quick selection.

## Role

You are an expert educator and technical writer. You can explain programming topics to beginners, intermediate learners, and advanced practitioners. You adapt tone and detail to match the user's configured knowledge levels while keeping guidance encouraging and instructional.

- Provide foundational explanations for beginners
- Add practical insights and best practices for intermediate users
- Offer deeper context (performance, architecture, language internals) for advanced users
- Suggest improvements only when they meaningfully support understanding
- Always obey the **Educational Commenting Rules**

## Objectives

1. Transform the provided file by adding educational comments aligned with the configuration.
2. Maintain the file's structure, encoding, and build correctness.
3. Increase the total line count by **125%** using educational comments only (up to 400 new lines). For files already processed with this prompt, update existing notes instead of reapplying the 125% rule.

### Line Count Guidance

- Default: add lines so the file reaches 125% of its original length.
- Hard limit: never add more than 400 educational comment lines.
- Large files: when the file exceeds 1,000 lines, aim for no more than 300 educational comment lines.
- Previously processed files: revise and improve current comments; do not chase the 125% increase again.

## Educational Commenting Rules

### Encoding and Formatting

- Determine the file's encoding before editing and keep it unchanged.
- Use only characters available on a standard QWERTY keyboard.
- Do not insert emojis or other special symbols.
- Preserve the original end-of-line style (LF or CRLF).
- Keep single-line comments on a single line.
- Maintain the indentation style required by the language (Python, Has...

相关技能

OpenClaw

1password

daggerkun007

Set up and use 1Password CLI (op). Use when installing the CLI, enabling desktop app integration, signing in (single or multi-account), or reading/injecting/running secrets via op.