python / python/python-insider-blog
README instructions for writing blog entries do not work as-is
まだ誰も着手していません。
- 主要言語
- Astro
- スター
- 32
- フォーク
- 12
- 平均マージ
- 9時間 37分
- マージ済み PR（30日）
- 9
説明
The README currently says:
You can pull the repo, run
make dev, and edit the page via Keystatic with the nice UI
I did so, and noticed that this had an implicit dependency on Bun. This dependency should be called out.
After installing Bun, I got a different failure due to the astro not being installed:
❯ make dev
bun run dev
$ astro dev
/bin/bash: astro: command not found
error: script "dev" exited with code 127
make: *** [dev] Error 127
This is because, the user needs to do a make install before make dev.
I did end up writing it in Markdown, since I'm familiar with that.
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
ブログエントリの作成手順に関する README の説明を更新する。make dev と make install のワークフローを確認して、記載されているセットアップを検証し、そのうえで Bun が必須であり、make dev の前に make install を実行する必要があることを明記する。新しいコントリビューターが報告されたエラーに遭遇せずに手順に従えることを完了条件とする。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- bun
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 1/5
- 見積もり時間
- 1時間未満
- 活発さ
- 静か
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 78/100