Documentation / Quick Start guide

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

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

評価

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

調査の方向性

https://github.com/nexB/univers#examples にある既存の例と、プロジェクトの Read the Docs ドキュメントから始めます。ライブラリの使い方を説明する小さなチュートリアルを作成し、それを Read the Docs で公開して、クイックスタートの流れが理解しやすいことを確認します。

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

説明

documentation

We should have a tiny tutorial on rtd about how to use this library. At the moment, we have https://github.com/nexB/univers#examples

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

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

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

aboutcode-org/univers のほかの issue

aboutcode-org/univers の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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