How/where/what to document
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
調査の方向性
特定のファイル、テスト、エントリーポイントは特定されていません。まず既存の README とドキュメント構成を確認し、その後、権限、ルート、ユーザーフロー、開始方法に関する情報をどこに配置すべきかを定めたコントリビューションガイドを作成してください。
索引モデルが issue の本文から書いたものです。
説明
I have always felt that there should be more of a process/guidelines when it comes to documenting stuff. I imagine there is a lot overlap with what you want to be documented across projects (permissions/routes/user-flows/getting-started/...).
It would help to have a specific guide to follow so that I know where to add this piece of information rather than just stick it on the end of a potentially long readme.
- 主要言語
- 言語のデータがありません
- スター
- 92
- フォーク
- 9
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
dwyl/contributing のほかの issue
-
bug chore starter
難易度 1/5 1時間未満 初心者へのやさしさ 38/100
dwyl/contributing#119 · リアクション 1 件 ·
-
enhancement starter
難易度 1/5 1〜3時間 初心者へのやさしさ 35/100
dwyl/contributing#118 · リアクション 1 件 ·
-
discuss enhancement
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
dwyl/contributing#113 · リアクション 2 件 ·
-
discuss enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 35/100
dwyl/contributing#112 · リアクション 1 件 ·
-
Draft Pull Requests!オープンdiscuss enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 42/100
dwyl/contributing#111 · コメント 2 件 · リアクション 3 件 ·
dwyl/contributing の issue をすべて見る
似ている issue
-
難易度 1/5 1〜3時間 初心者へのやさしさ 66/100
betagouv/conseillers-entreprises#4770 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
awsdocs/amazon-eks-user-guide#1257 ·
-
難易度 1/5 1〜3時間 初心者へのやさしさ 65/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 63/100
メンテナーはふだん 1 日以内に返信
-
status:untriaged
難易度 1/5 1時間未満 初心者へのやさしさ 86/100
midnightntwrk/servicedesk#275 ·
メンテナーはふだん 1 日以内に返信