Doc coverage
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 45/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 活発
- 技術スタック
- github-actions, python
- 領域
- ci-cd, documentation, testing-qa
調査の方向性
Start with docs/source/tutorials/ and the existing command pytest --nbval docs/source/tutorials/ --cov=causal_testing --cov-report=html. Investigate how tutorial execution, coverage reporting, and GitHub Actions are currently configured. Done should be a documented workflow that reports tutorial code coverage and exposes the result through a badge, with exclusions supported.
索引モデルが issue の本文から書いたものです。
説明
Given a tutorial folder, what percentage of the code base is (recursively) imported AND USED at any point into the tutorials? Github action and badge.
This can be done (naively) as follows:
- Take the tutorials and run them
- Measure code coverage
- What percentage of codebase was covered? (ignore exceptions, have a #pragma no cover type comment)
Does this exist?! This is much more generally applicable than just for CTF, but I really want it to stop me merging undocumented PRs.
This is just codecov isn't it.
pytest --nbval docs/source/tutorials/ --cov=causal_testing --cov-report=html
- 主要言語
- Python
- スター
- 20
- フォーク
- 7
- 平均マージ
- 8日 21時間
- マージ済み PR（30日）
- 2
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
CITCOM-project/CausalTestingFramework のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 3/5 1〜2日 初心者へのやさしさ 50/100
-
Pydantic for serialisation対応中かも @SylviaWhittle が 14 日前に担当しました。 オープン
CITCOM-project/CausalTestingFramework#419 · 担当者 1 名 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 64/100
CITCOM-project/CausalTestingFramework の issue をすべて見る
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 68/100
メンテナーはふだん 4 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
ClockGU/clockwork-backend#169 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
aws-samples/sample-per-model-bedrock#616 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
chnm/teachinghistory-hugo#47 ·
-
good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
pandas-dev/pandas-stubs#2047 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信