eduaguilera/whep

Proofread README.Rmd

Open

#22 opened on Jul 11, 2025

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)R (3 forks)auto 404
dev-infradocumentationgood first issuehelp wantedmechanicalno-data-neededpriority:medium

Repository metrics

Stars
 (1 star)
PR merge metrics
 (Avg merge 4d 2h) (263 merged PRs in 30d)

Description

The homepage must give a good impression about the package and the project. It might contain some unclear parts. Proofread and make it clearer.

The file that must be updated is README.Rmd, which must then automatically update README.md by using devtools::build_readme(). The page I refer to is the one at https://eduaguilera.github.io/whep/.

Contributor guide

Research direction
Read the current README.Rmd file in the repository, identify unclear or imprecise parts, and rewrite them for clarity. Then run devtools::build readme() to update README.md.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitR
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85