Skip to content

Add Documentation category (docstring + type hints) to coding-standards #3

@DaisukeYoda

Description

@DaisukeYoda

概要

coding-standards に Documentation カテゴリが存在しない。docstring と型ヒントは AI コーディングエージェント向けルールとして相性が良く、最も大きな空白なので新設したい。

追加候補ルール

  • doc-docstring — 公開関数/クラスに Google スタイル docstring を付与
  • doc-type-hints — 公開 API の引数・戻り値に型注釈を必須化

備考

  • 既存の skills/coding-standards/rules/_template.md の形式に沿って作成する
  • カテゴリ Impact は HIGH 想定
  • README のカテゴリ表も更新する

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions