comment-code-generate-a-tutorial
このPythonスクリプトを、コードのリファクタリング・わかりやすい解説コメントの追加・完全なMarkdownチュートリアルの生成を通じて、初心者にも親しみやすい洗練されたプロジェクトへと仕上げます。
description の原文を見る
Transform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown tutorial.
SKILL.md 本文
このPythonスクリプトを、コードをリファクタリングし、明確な説明コメントを追加し、完全なMarkdownチュートリアルを生成することで、初心者向けの洗練されたプロジェクトに変換します。
-
コードをリファクタリング
- 標準的なPythonベストプラクティスを適用
- コードがPEP 8スタイルガイドに従うことを確認
- 明確にするために必要に応じて変数と関数を名前変更
-
コード全体にコメントを追加
- 初心者向けで教育的なトーンを使用
- コードの各部分が何をしているのか、そしてなぜ重要なのかを説明
- 構文ではなく、ロジックと推論に焦点を当てる
- 冗長または表面的なコメントは避ける
-
チュートリアルを
README.mdファイルとして生成
以下のセクションを含める:- プロジェクト概要: スクリプトの機能と有用な理由
- セットアップ手順: 前提条件、依存関係、スクリプトの実行方法
- 動作原理: コメントに基づくコードロジックの詳細説明
- 使用例: スクリプトの使い方を示すコードスニペット
- サンプル出力: (オプション) スクリプトが目に見える結果を返す場合は含める
- 明確で読みやすいMarkdown書式を使用
ライセンス: MIT(寛容ライセンスのため全文を引用しています) · 原本リポジトリ
詳細情報
- 作者
- github
- ライセンス
- MIT
- 最終更新
- 不明
Source: https://github.com/github/awesome-copilot / ライセンス: MIT
関連スキル
doubt-driven-development
重要な判断はすべて、本番環境への展開前に新しい視点から対抗的レビューを実施します。速度より正確性が重要な場合、不慣れなコードを扱う場合、本番環境・セキュリティに関わるロジック・取り消し不可の操作など影響度が高い場合、または後でバグを修正するよりも今検証する方が効率的な場合に活用してください。
apprun-skills
TypeScriptを使用したAppRunアプリケーションのMVU設計に関する総合的なガイダンスが得られます。コンポーネントパターン、イベントハンドリング、状態管理(非同期ジェネレータを含む)、パラメータと保護機能を備えたルーティング・ナビゲーション、vistestを使用したテストに対応しています。AppRunコンポーネントの設計・レビュー、ルートの配線、状態フローの管理、AppRunテストの作成時に活用してください。
desloppify
コードベースのヘルスチェックと技術負債の追跡ツールです。コード品質、技術負債、デッドコード、大規模ファイル、ゴッドクラス、重複関数、コードスメル、命名規則の問題、インポートサイクル、結合度の問題についてユーザーが質問した場合に使用してください。また、ヘルススコアの確認、次の改善項目の提案、クリーンアップ計画の作成をリクエストされた際にも対応します。29言語に対応しています。
debugging-and-error-recovery
テストが失敗したり、ビルドが壊れたり、動作が期待と異なったり、予期しないエラーが発生したりした場合に、体系的な根本原因デバッグをガイドします。推測ではなく、根本原因を見つけて修正するための体系的なアプローチが必要な場合に使用してください。
test-driven-development
テスト駆動開発により実装を進めます。ロジックの実装、バグの修正、動作の変更など、あらゆる場面で活用できます。コードが正常に動作することを証明する必要がある場合、バグ報告を受けた場合、既存機能を修正する予定がある場合に使用してください。
incremental-implementation
変更を段階的に実施します。複数のファイルに影響する機能や変更を実装する場合に使用してください。大量のコードを一度に書こうとしている場合や、タスクが一度では完結できないほど大きい場合に活用します。