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

Đang mở
  • Có gì không ổn?
#217 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
58/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
github, markdown, r
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.
Ngôn ngữ chính
R
Star
43
Fork
14
Merge trung bình
4 giờ 44 phút
Pull request đã merge (30 ngày)
15

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của DARTH-git/dampack

Tất cả issue của DARTH-git/dampack

Issue tương tự

Thêm issue về R

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.