本文へ移動
cccskills
無料GitHub で公開

neohaskell-module-docs

Write and verify top-level Haddock for every new Haskell module, including generated module templates and complete fixture modules. Use when creating or reviewing new modules.

日本語の概要は準備中です。原文の説明を表示しています。

neohaskell/NeoHaskellスター 348(GitHub 348 + cccskills 0)

実行スコア 未検証

インストール方法を見る

含まれるファイル(1)

  • SKILL.md2.0 KB

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

Document each new module

Every newly created Haskell module must have a concise top-level Haddock comment before its module declaration. State the module's responsibility and normal usage. The header explains the module as a whole. Operation names still need to communicate what calls do under Name for the reader.

  1. Inventory added Haskell files against the owning base with git diff --name-status --diff-filter=A <owning-base> -- '*.hs'. Include staged and untracked additions, generated module templates, and complete fixture modules that the diff command cannot enumerate.
  2. Write the header when creating the module. Describe what it owns and how a caller normally uses it. Omit change history, implementation narration, and instructions to future agents.
  3. Check every inventory entry before review. Read the exported contract and representative use to confirm that the header is accurate. Run the relevant compiler or Haddock check when markup, references, or generated output change.
  4. Preserve qualifying module headers during comment review. Report missing or inaccurate headers as authoring defects instead of deleting the obligation.

This complete illustrative module owns a mail-delivery decision. Its header states that responsibility and the caller's normal use.

{-| Decide whether to attempt a mail delivery.
Call 'shouldDeliver' with the recipient's opt-in state before queuing mail.
-}
module Mail.DeliveryPolicy (shouldDeliver) where

import Core

shouldDeliver :: Bool -> Bool
shouldDeliver optedIn = optedIn

The illustrative predicate only models opt-in. Real policy belongs in its owning module and must state any stronger guarantee it promises.

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

コメント

ログインなしで書き込めます。使ってみた感想、質問、動かなかった環境などを気軽にどうぞ。

まだコメントはありません。最初のコメントを書いてみませんか。

送信するとすぐに公開されます。メールアドレスや電話番号などの個人情報は書かないでください。URL は 2 つまでです。

0 / 1000 文字

このフォームは reCAPTCHA で保護されており、Google のプライバシーポリシーと利用規約が適用されます。

同じリポジトリのスキル

Write or review the published NeoHaskell agent guide for generated applications. Use for docs/agent changes and consumer-facing framework changes that may make the guide stale.

日本語の概要は準備中です。原文の説明を表示しています。

neohaskell/NeoHaskell3482026年10月29日 更新

architect

無料

Sketch types, signatures, and module structure before code, then stay in the loop while implementation fills in. Use for /architect, 'architect this', 'design this', or non-trivial work where jumping to code would lock in the wrong shape.

日本語の概要は準備中です。原文の説明を表示しています。

neohaskell/NeoHaskell3482026年10月29日 更新

arena

無料

Spawn N parallel candidates at the same task, pick a base, graft the strongest parts of the losers into it. Use for /arena, 'arena this', 'throw it in the arena', or when one attempt at a non-trivial artifact would lock in the wrong shape.

日本語の概要は準備中です。原文の説明を表示しています。

neohaskell/NeoHaskell3482026年10月29日 更新

babysit

無料

Inspect or supervise a PR or stack through review and CI to merge-ready, using current GitHub evidence and the requested mode.

日本語の概要は準備中です。原文の説明を表示しています。

neohaskell/NeoHaskell3482026年10月29日 更新

Vet a perf measurement (limiter, tuning, limits, errors, repeatability, relevance, and whether the work happened) before you report or act on it. Use when you benchmark or report a measured speedup or regression, including complete framework flows and compilation of projects that consume the framework.

日本語の概要は準備中です。原文の説明を表示しています。

neohaskell/NeoHaskell3482026年10月29日 更新

bro

無料

Restate the last message in plain human language, with no jargon.

日本語の概要は準備中です。原文の説明を表示しています。

neohaskell/NeoHaskell3482026年10月29日 更新

neohaskell のスキルをすべて見る

このスキルの問題を報告する