Back to list
Sun-Lab-NBB

applying-sun-lab-style

by Sun-Lab-NBB

A Python library that provides tools to acquire, manage, and preprocess scientific data in the Sun (NeuroAI) lab.

2🍴 1📅 Jan 24, 2026

SKILL.md


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

CRITICAL: You MUST read the appropriate guide before performing any task. The quick reference section below is insufficient for compliance. Each guide contains detailed rules and verification checklists that you MUST follow.

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

Do not skip reading the guide. The quick reference is only a reminder for frequently used rules, not a substitute for the full guide.


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 (Not a Substitute for Full Guides)

These are reminders only. You MUST read the full guide for your task before proceeding.

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
  • Multi-line commits: blank line after header, then -- prefixed bullets

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

Score

Total Score

75/100

Based on repository quality metrics

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

+10
説明文

100文字以上の説明がある

+10
人気

GitHub Stars 100以上

0/15
最近の活動

1ヶ月以内に更新

+10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

+5

Reviews

💬

Reviews coming soon