moscajs/mosca

Write documentation in plain markdown

オープン

#501 opened on 2016/06/18

GitHub で見るコントリビューターガイド
 (0 件のコメント) (0 件のリアクション) (0 人の担当者)JavaScript (498 件のフォーク)github user discovery
help wanted

Repository metrics

Stars
 (3,186 個のスター)
PR merge metrics
 (30d に merged PR はありません)

説明

Currently the documentation is written inlined in the code, using a (now-broken) documentation generation system.

We should rewrite this into a doc folder just using "plain" markdown.

コントリビューターガイド

調査方針
ソースコード内の既存のインラインドキュメントを確認し、新しい'doc'フォルダを作成して、内容を構造化されたプレーンマークダウンファイルに複製します。
技術スタック
javascript
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
半日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
GitMarkdown
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90