README.Rmd with statement of need, minimal example and badges

Aperta
  • Qualcosa non va?
#217 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
58/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
github, markdown, r
Ambito
documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation

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_TOKEN secret is added), pkgdown site, lifecycle, and JOSS after acceptance.

Acceptance

  • The README renders on GitHub and pkgdown.
  • urlchecker::url_check() is clean.
Lingua principale
R
Stelle
43
Fork
14
Merge medio
4h 44m
PR unite (30g)
15

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di DARTH-git/dampack

Tutte le issue di DARTH-git/dampack

Issue simili

Altre issue su R

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.