README.Rmd with statement of need, minimal example and badges
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 58/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- github, markdown, r
調査の方向性
Start by reading the existing README and the linked .github/CONTRIBUTING.md; use usethis::use_readme_rmd() as the named entry point. Include the requested statement of need, installation steps, minimal cancer_psa_data example, links, citation, contribution/help and funding details, and correct the listed text and badges. Check that the README renders on GitHub and pkgdown, then run urlchecker::url_check() and confirm it is clean.
索引モデルが issue の本文から書いたものです。
説明
Suggested owner: Eva Enns or Fernando Alarid-Escudero · Plan: Phase 4
Goal
A README that works as the landing page for CRAN, GitHub, pkgdown and JOSS reviewers.
Scope
usethis::use_readme_rmd()with:- A statement of need.
- Installation instructions (CRAN and GitHub).
- A minimal example with one figure, using
cancer_psa_data. - Links to the vignettes and the pkgdown site.
citation("dampack").- Contributing and getting help, linking
.github/CONTRIBUTING.md, the Code of Conduct, and the issue templates (added in #206). - The funding statement.
- Fix the README text:
- It says "six vignettes" but lists five.
- The maintainer and contributor list omits Matthew Kaufmann and Caleb Easterly.
- Remove the commented-out Travis badge.
- Badges: CRAN version, R-CMD-check, lint, Codecov (once the
CODECOV_TOKENsecret is added), pkgdown site, lifecycle, and JOSS after acceptance.
Acceptance
- The README renders on GitHub and pkgdown.
urlchecker::url_check()is clean.
- 主要言語
- R
- スター
- 43
- フォーク
- 14
- 平均マージ
- 4時間 44分
- マージ済み PR（30日）
- 15
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
DARTH-git/dampack のほかの issue
-
documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
メンテナーはふだん 1 日以内に返信
-
release
難易度 5/5 1週間以上 初心者へのやさしさ 20/100
メンテナーはふだん 1 日以内に返信
-
documentation release
難易度 3/5 1〜2日 初心者へのやさしさ 25/100
メンテナーはふだん 1 日以内に返信
-
documentation
難易度 4/5 1週間以上 初心者へのやさしさ 15/100
DARTH-git/dampack#216 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
DARTH-git/dampack の issue をすべて見る
似ている issue
-
documentation priority: low
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
Pascal-Kueng/dyadMLM#179 ·
メンテナーはふだん 1 日以内に返信
-
Consider changesオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
OHDSI/OmopSketch#618 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
-
bug exec:agent status:fix-merged
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
ichirio/rtfreporter#1046 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信