pyvec / pyvec/python.cz

Lepší README

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

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

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

説明

Hlavně aby dokumentovalo, jak rozběhat projekt a co je účelem webovky (a co účelem té webovky - už - není). Viz https://github.com/pyvec/python.cz/pull/559

Hlavně zmínit, že skoro všechno je prostě zdokumentováno v dokumentaci MkDocs a hlavně mkdocs-material

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

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

はじめの一歩

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

調査の方向性

README から始め、参照されている pull request #559 を確認します。既存の MkDocs と mkdocs-material のドキュメントを確認し、プロジェクトの実行方法、ウェブサイトの目的、そしてウェブサイトが担わなくなった責務をまとめます。README が読者を関連するドキュメントへ案内し、セットアップと目的を明確に説明していれば完了です。

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

評価

領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

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

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