README.Rmd with statement of need, minimal example and badges
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 58/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- github, markdown, r
- Área
- documentation
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- R
- Estrellas
- 43
- Forks
- 14
- Merge medio
- 4 h 44 min
- PR fusionados (30 d)
- 15
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de DARTH-git/dampack
-
documentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
documentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
Los mantenedores suelen responder en 1 día
-
Release dampack 1.1.0 to CRANAbiertorelease
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
Los mantenedores suelen responder en 1 día
-
documentation release
Dificultad 3/5 1-2 días Aptitud para principiantes 25/100
Los mantenedores suelen responder en 1 día
-
documentation
Dificultad 4/5 Más de una semana Aptitud para principiantes 15/100
DARTH-git/dampack#216 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
Todos los issues de DARTH-git/dampack
Issues similares
-
documentation priority: low
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
Pascal-Kueng/dyadMLM#179 ·
Los mantenedores suelen responder en 1 día
-
Consider changesAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
OHDSI/OmopSketch#618 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
-
bug exec:agent status:fix-merged
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
ichirio/rtfreporter#1046 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 82/100
Los mantenedores suelen responder en 1 día