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

Move several examples from the docs to tests and then `literalinclude` them

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

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
python
領域
documentation, testing-qa

調査の方向性

docs/pages/future.rst、docs/pages/contrib/hypothesis_plugins.rst、docs/pages/context.rst にある3つの例から始め、その後 tests/test_docs を調べてください。例をそのテスト領域に移し、literalinclude ディレクティブとソースへのリンクに置き換え、必要な場合にのみ pyproject.toml または docs/requirements.txt を更新してください。flake8、mypy、pytest を実行してください。例が取り込まれ、リンクされ、動作していれば完了です。

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

説明

documentation enhancement good first issue hacktoberfest help wanted

We have several quite large examples that live in our docs:

  1. https://github.com/dry-python/returns/blob/master/docs/pages/future.rst#futureresult
  2. Number example from: https://github.com/dry-python/returns/blob/master/docs/pages/contrib/hypothesis_plugins.rst#check_all_laws
  3. https://github.com/dry-python/returns/blob/master/docs/pages/context.rst#requirescontextfutureresult-container

What needs to be done?

  • We need to extract these examples from docs to tests/test_docs folder
  • Instead, we should add this:
.. literalinclude:: ../../tests/test_docs/test_${SOME_NEW_FILENAME}.py
   :linenos:
  • Provide a link to the source code on github somewhere near the example itself
  • Possibly we would need to add some dev-dependencies to both pyproject.toml and docs/requirements.txt
  • Make sure that it is checked by flake8, mypy, and pytest. And that it actually works.

This way we would have nice, complex, but working examples! 📖

主要言語
Python
スター
4.4k
フォーク
154
平均マージ
3時間 5分
マージ済み PR（30日）
22

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

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

dry-python/returns のほかの issue

dry-python/returns の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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