Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Enhance the tech_review hook

オープン
#282 コメント 1 件 リアクション 2 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
python
領域
tooling

調査の方向性

まず、既存の tech_review hook と、それが Python ファイルおよびディレクトリをどのように選択するかを確認します。次に docstring_parser のドキュメントを読み、検証を tech_review に含めるべきか、新しい hook に含めるべきかを決定します。選択された関数とクラスの docstring が解析され、準拠していないケースが報告されれば完了です。

索引モデルが issue の本文から書いたものです。

説明

enhancement
📝 Description of the feature

Use the docstring parser to check docstrings in repositories are valid/compliant as suggested by @AlejandroFernandezLuces

Perhaps we can make this a new hook or add it to the tech_review hook

💡 Steps for implementing the feature
  • Look through each python file in certain directories & parse the docstrings in each function and/or class
🔗 Useful links and references

docstring parser

主要言語
Python
スター
5
フォーク
1
平均マージ
1時間 36分
マージ済み PR(30日)
7

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ansys/pre-commit-hooks のほかの issue

ansys/pre-commit-hooks の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。