Re-enable `jsdoc/require-jsdoc`

オープン
#7,628 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
リファクタリング
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
eslint, typescript
領域
tooling

調査の方向性

まず、jsdoc/require-jsdoc が無効になっているパッケージ固有の lint 設定を見つけ、次にそれを有効にするパッケージを 1 つ選びます。そのパッケージの lint チェックを実行し、結果として発生したドキュメントルール違反を解消します。完了とは、他のルールに違反するスタブコメントを残さずにルールが有効になっていることを意味します。

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

説明

team-core-platform

The rule jsdoc/require-jsdoc was temporarily disabled because the auto-fixer doesn't work very well (it produced not-very-useful "stub" comment blocks that then violated a bunch of other rules without auto-fixers).

We can enable it one package at a time to break the work up.

主要言語
TypeScript
スター
420
フォーク
313
平均マージ
1日 12時間
マージ済み PR(30日)
384

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

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

MetaMask/core のほかの issue

MetaMask/core の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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