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

Update documentation to better explain `@wip` tag

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

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

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
68/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
静か
技術スタック
python
領域
documentation

調査の方向性

docs/source/development.rst と README.rst から始め、次に gherkinize.py を読んで、cel-spec のテストデータがどのように features ディレクトリのツリーになり、@wip タグを付けられるのかを理解します。Development Tools の説明を更新し、README へのリンクを追加します。完全な feature-list ページはすでに #191 によって完了としてマークされています。両方のドキュメントパスでフローが明確に説明され、正しくリンクされていれば完了です。

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

説明

documentation enhancement tracking

Three related changes to the documentation.

  • Update the Development Tools section (docs/source/development.rst) to include an explanation of the @wip tag, and how the test data flows from cel-spec to the features directory tree with tags injected by the gherkinize.py tool.

  • Add a link to this to the README.rst to provide a clear path to show how @wip tags are injected into the tests.

  • Add a page with the complete list of features, showing ✅ and ❌ for the features supported and the features marked @wip. (It's not clear precisely how to do this. It might be an useful secondary output from the gherkinize.py tool.) Completed by #191

主要言語
Python
スター
174
フォーク
40
PR マージ指標
30日以内にマージされた PR はありません

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

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

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

cloud-custodian/cel-python のほかの issue

cloud-custodian/cel-python の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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