go-docstring-style

Enforces docstring writing in this Go project for functions, methods, and struct fields, with approved exceptions and multiline parameter supplements.

Skill by tomyou666

IndexedMIT

Write a review

Install

Works with Claude Code, Claude apps, Codex, Cursor, Gemini CLI, GitHub Copilot, VS Code, OpenCode, Goose, Windsurf. Read the repository before you give any tool access to your data.

npx agentmarket install skill/tomyou666-go-docstring-style

Asks which of your tools to add it to (Claude Code, Codex, Cursor, VS Code, Windsurf, Gemini CLI, Claude Desktop) and shows the change first. See https://agentmart.dev/cli.

Get the weekly diff

The weekly diff: one email a week with new agent tools, notable updates and grade changes, plus security alerts for tools you follow. Double opt-in, one-click unsubscribe.

About

Enforces docstring writing in this Go project for functions, methods, and struct fields, with approved exceptions and multiline parameter supplements. Use only when the user explicitly invokes this skill (e.g. /go-docstring-style).

Use cases: writing

Reviews

Write a review

No reviews yet. Installed it? Reviews come from verified installers only. How reviews work

Permissions

What this skill can do and what it asks for, from its SKILL.md. Checked Oct 25, 2026.

Tools: No tools found
Secrets: None asked for
Install scripts: None found

Network hosts it talks to 1

codeload.github.com · found in install command

Files it touches

~/.claude/skills/go-docstring-style

What's inside

Skill name: go-docstring-style
Description: Enforces docstring writing in this Go project for functions, methods, and struct fields, with approved exceptions and multiline parameter supplements. Use only when the user explicitly invokes this skill (e.g. /go-docstring-style).
License: MIT
Instructions: 56 lines in SKILL.md · view on GitHub

Files (1)

SKILL.md

SKILL.md (first lines)

# Go Docstring Style

このgoのプロジェクトにおいて、関数、メソッド、または構造体（Struct）のフィールドにおいてはdocstringを書くようにしてください。

## 適用対象

- すべての関数
- すべてのメソッド
- 構造体のフィールド

`exported` な要素は常に docstring 必須です。

## 例外（承認済み）

以下のみ例外として docstring を省略できます。

1. 明らかな一時変数用の匿名構造体フィールド
2. enum のように `mode` が複数分かれる説明箇所

## 引数説明の特別ルール（承認済み）

例外的に引数の説明を文章の中で改行を入れて補足してください。

運用ルール:

- 引数説明が長くなる場合は、docstring 本文で改行して補足を入れる
- 特に `mode` 引数は、取りうる値と挙動差分を改行付きで明示する

## 書き方ルール

1. 先頭で要約を1文で書く
2. 必要なら詳細を複数行で補足する
3. 引数の意味、単位、前提条件、失敗条件を必要に応じて書く
4. 挙動が分岐する `mode` は値ごとの差を明示する

## 最低テンプレート

```go
// DoThing は X を実行する。
//
// mode は実行モードを表す。
// "fast": 検証を簡略化して高速実行する。
// "safe": 追加検証を行って安全に実行する。
func DoThing(mode string) error {
    // ...
    return nil
}
```

## 実装時チェック

- docstring が不足している要素を追加したか
- 例外が承認済み2条件に該当するかを確認したか
- `mode` など分岐引数の説明を改行補足で記述したか

From tomyou666/skills, MIT.

Signals

Stars: 0
Forks: 0
Open issues: 0
Last commit (this folder): Sep 27, 2026 (1 month ago)

From GitHub (fetched Oct 24, 2026).

Details

License: MIT
Repository: github.com/tomyou666/skills
First seen: Oct 24, 2026
Last checked: Oct 24, 2026
Source: GitHub github-graphql

More from tomyou666

Cite this page

go-docstring-style skill. Agent Mart. https://agentmart.dev/skills/tomyou666-go-docstring-style (last updated 2026-10-24)