Start tracking Rd files on GitHub
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 401
- Forks
- 136
- PR merge metrics
- No merged PRs in 30d
Description
rstanarm doesn't track Rd files on GitHub, which results in the doc not being included in various situations (see e.g. @ermeel86's comment https://github.com/stan-dev/rstanarm/issues/442#issuecomment-683775455, but there are also other cases) . @bgoodri I forget why this decision was made initially, but rstanarm might be the only R package on GitHub that doesn't track the Rd files (at least it's hard to find another one). I don't think there's a good reason not to track them at this point, so I think we should start doing it. Objections?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Inspect how rstanarm currently generates and excludes Rd files, then check the repository contents and package documentation workflow. Done means the generated Rd files are tracked on GitHub and documentation is included in the situations described by the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100