python / python/python-docs-pt-br

Melhorar o README

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

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

enhancement help wanted
主要言語
Python
スター
164
フォーク
42
平均マージ
14時間 32分
マージ済み PR(30日)
4

説明

Atualmente o README deste repositório contém apenas o CLA e badge de CI.

Penso que seria interessante termos mais informações nele que sejam úteis tanto para usuários atuais quanto novatos/passageiros. Por exemplo, poderíamos ter instruções sobre como compilar a documentação traduzida ou um link para o grupo do Telegram para quem quiser possa nos contatar.

Ideias, sugestões?

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

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

はじめの一歩

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

調査の方向性

まず、現在のリポジトリの README を確認します。現在は CLA と CI バッジしか含まれていません。maintainer と希望する範囲を確認したうえで、翻訳されたドキュメントのコンパイル方法を文書化し、合意された場合は Telegram グループへのリンクを追加します。README は現在のユーザーと新規ユーザーの両方に役立つガイダンスを提供する必要があります。

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

評価

技術スタック
python
領域
documentation, localization
issue の種類
ドキュメント
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

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

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