[go: up one dir, main page]
Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Harmonize READMEs across the ecosystem #364

Open
IndrajeetPatil opened this issue Apr 2, 2023 · 3 comments
Open

Harmonize READMEs across the ecosystem #364

IndrajeetPatil opened this issue Apr 2, 2023 · 3 comments
Labels
Core Packages 📦 Discussion and planning about core packages of easystats Documentation 📚

Comments

@IndrajeetPatil
Copy link
Member

Currently, README in every easystats repo seems to be doing its own thing. Since all of them belong to the same ecosystem, we should try to follow a standard template for things which are common to all repos.

Here are some key features to standardize (and which currently differ across repos):

  • Top-level badges
  • Installation instructions
  • Badges in installation
  • Citation
  • Documentation badges

Here are my preferences, but, of course, we can update these based on your feedback:

  • Top-level badges: R-CMD-check, only total downloads, dependency count, codecov, lifecycle
  • Installation instructions: Table with CRAN, r-universe, and pak options
  • Badges in installation: None
  • Citation: JOSS (if available), otherwise package citation
  • Documentation badges: Only website badge
@IndrajeetPatil IndrajeetPatil added Core Packages 📦 Discussion and planning about core packages of easystats Documentation 📚 labels Apr 2, 2023
@bwiernik
Copy link
Contributor
bwiernik commented Apr 2, 2023

I prefer to list both the journal citation and package citation.

@mattansb
Copy link
Member
mattansb commented Apr 7, 2023

I prefer avoiding tables for installation. Also, I see no need to promote pak. Users that use it will know what to do, and those that don't might be confused by the extra step.
Also, since we use r-universe, I think we can drop the remotes package as well.

@etiennebacher
Copy link
Member

I see no need to promote pak. Users that use it will know what to do, and those that don't might be confused by the extra step.

Agreed and pak can have some issues on servers (I ran into this) so I think it's better to stick to install.packages()

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Core Packages 📦 Discussion and planning about core packages of easystats Documentation 📚
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@bwiernik @IndrajeetPatil @mattansb @etiennebacher