marshmallow-code / marshmallow-code/webargs
Add an 'Examples' page to the docs with fully functioning example applications
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 1.4k
- フォーク
- 167
- 平均マージ
- 17時間 8分
- マージ済み PR(30日)
- 4
説明
There are a few cases of interesting usages that come up in issues, but which don't seem appropriate to put into our main docs (b/c we don't want to bloat our docs). If we had an Examples page in the docs, we could show off all of our cool ideas for how you can solve problems with webargs, but without disrupting the flow of the main documentation.
Specific cases which would be good candidates for example apps:
- Django App with CSRF-Removing Parser
- Axios Query-String Parser
- Setting a parser to use
unknown=RAISEon query params
I did a quick scan of closed issues until I hit the 5.x/6.0 transition point, then called it a day. Maybe there are other interesting examples in older issues? Or maybe we have things in other parts of the docs like the upgrade guide which would be nice to separate out (or even just duplicate).
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、Django CSRF-removing parser と Axios query-string parser に関するリンク先の issue のコメントを確認し、次に既存の webargs ドキュメントと upgrade guide を調べて他の候補を探します。Examples page の構成を定義し、完全に動作するアプリケーションを絞り込んで選定します。ページと実行可能な例が合意したケースを網羅し、メインドキュメントを肥大化させていなければ完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- django, javascript, python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100