thoughtbot/Argo

Generate documentation as a part of the release process

オープン

#437 opened on 2016/12/05

GitHub で見るコントリビューターガイド
 (0 件のコメント) (0 件のリアクション) (0 人の担当者)Swift (214 件のフォーク)batch import
documentationenhancementhelp wanted

Repository metrics

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

説明

It'd be dope if we could automatically generate project documentation (via Jazzy probably?) as a part of the release process and add it to the web directory so that we can serve it with GitHub pages.

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

調査方針
Jazzyを使用してSwiftドキュメントを生成し、リリースプロセスにJazzyを実行して出力をwebディレクトリにコミットするスクリプトを追加してGitHub Pagesで提供する方法を調査してください。
技術スタック
swift
領域
documentationrelease
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
SwiftGitCI/CD
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70