AgentSkillsCN

applying-sun-lab-style

在编写、审查或重构代码时，严格遵循 Sun Lab 的 Python 编码规范。涵盖 .py 文件、文档字符串、类型注解、命名规范、README.md 文件、Git 提交信息，以及 Claude 技能文件。适用于编写新代码、修改现有代码、审查拉取请求、撰写文档、编写提交信息，或当用户就编码标准提出疑问时。

SKILL.md
--- frontmatter
name: applying-sun-lab-style
description: >-
  Applies Sun Lab Python coding conventions when writing, reviewing, or refactoring code. Covers
  .py files, docstrings, type annotations, naming conventions, README.md files, git commit messages,
  and Claude skill files. Use when writing new code, modifying existing code, reviewing pull requests,
  creating documentation, writing commit messages, or when the user asks about coding standards.

Sun Lab Style Guide

Applies Sun Lab coding and documentation conventions.

You MUST read the appropriate style guide and apply its conventions when writing or modifying any code, documentation, commits, or skills. You MUST verify your changes against the style guide's checklist before submitting.

Workflow Selection

Determine what you're modifying and read the appropriate guide:

TaskAction
Writing Python code?Read PYTHON_STYLE.md
Writing README?Read README_STYLE.md
Writing commit message?Read COMMIT_STYLE.md
Writing skill file?Read SKILL_STYLE.md

After reading the appropriate guide:

  1. •Apply all conventions from that guide
  2. •Verify against the guide's checklist before submitting

Style Guides

GuideUse When
PYTHON_STYLE.mdWriting Python code (docstrings, type annotations, naming, error handling)
README_STYLE.mdCreating or updating README files
COMMIT_STYLE.mdWriting git commit messages
SKILL_STYLE.mdCreating Claude skills or YAML configuration files

Quick Reference

Python Code (includes docstrings and inline comments)

  • •Docstrings: Google-style with Args, Returns, Raises, Notes, Attributes sections
  • •Prose Over Lists: Use prose in all documentation; bullet lists are forbidden in docstrings
  • •Inline Comments: Third person imperative, above the code, explain non-obvious logic
  • •Naming: Full words (position not pos), private members _underscore
  • •Type Annotations: All parameters and returns; always specify dtype for arrays
  • •Error Handling: Use console.error() from ataraxis_base_utilities
  • •Line Length: Maximum 120 characters

Commit Messages

  • •Start with past tense verb: Added, Fixed, Updated, Refactored, Removed
  • •Header line ≤ 72 characters
  • •End with a period

README Files

  • •Third-person voice throughout
  • •Present tense as default

Skills & Templates

  • •SKILL.md frontmatter: name (gerund form), description (third person)
  • •Line length ≤ 120 characters