Update installation docs and possibly Django
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 領域
- backend, documentation
調査の方向性
README と Makefile を読み、文書化されている Docker を使わないセットアップと、実際に使用されているコマンドおよび要件を比較します。Python と Django のサポート対象バージョンを確認し、Python 3.13 との互換性の問題も含めます。インストール手順に必要なバージョンとセットアップコマンドが明確に記載され、互換性のために必要であれば Django が更新されていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
I was interested in looking at a couple of the issues here, but the docs for getting things setup seem to be missing a few bits of information, and the current setup is not compatible with the latest version of Python
Notably:
- The
Makefilerelies on bothpipandpythonbeing present, however on every system I've used in the past ~10 years (MacOS and Ubuntu, can't speak for Windows) whenever you install Python3 through the normal package managers (even if not alongside Python2), the commands arepip3andpython3whereaspipandpythonhave tended to always refer to Python2. This can be worked around with some aliases and a venv, but I feel like this requirement should be noted somewhere in the docs to identify what version of Python should be used and/or the other general requirements to run the project - Similar to the first issue, the current Django version is not compatible with the latest version of Python. Currently PokeAPI uses Django v3.2.25, which is a year and 2 major versions behind the latest. The issue is that this version still relies on the
cgimodule, which was removed from Python in version 3.13 last year, and it's not clear in the README what version of Python is actually recommended (I had presumed the latest, but that was not the case)
I am aware of the Docker instructions, but the point still stands that the non-Docker instructions seem to be outdated and such
- 主要言語
- Python
- スター
- 5.4k
- フォーク
- 1.2k
- 平均マージ
- 2日 12時間
- マージ済み PR(30日)
- 18
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
PokeAPI/pokeapi のほかの issue
-
難易度 2/5 1〜2日 初心者へのやさしさ 76/100
-
bug
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
-
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
-
UV hardlink files オープン
難易度 3/5 1〜2日 初心者へのやさしさ 48/100
-
Ball legality オープン
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
PokeAPI/pokeapi の issue をすべて見る
似ている issue
-
agent-ready documentation needs-triage
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
-
documentation
難易度 1/5 1時間未満 初心者へのやさしさ 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" オープン
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
-
instance instance add
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
searxng/searx-instances#939 · コメント 1 件 ·
-
area-deployment area-integrations triage:bot-seen
難易度 2/5 半日 初心者へのやさしさ 86/100