Skip to content

Commit aa711c3

Browse files
authored
Merge pull request #72 from r-multiverse/review_package_function
Recommend multiverse.internals::review_package()
2 parents e0b8c84 + 216d8e3 commit aa711c3

File tree

2 files changed

+19
-5
lines changed

2 files changed

+19
-5
lines changed

contributors.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,23 @@ This page explains how to contribute packages to R-multiverse.
1010
including package contributions.
1111
Administrators, moderators, and contributors are all subject to the terms therein.
1212
The [review policy](review.md) specifically governs package contribution and review.
13+
In particular, please ensure your package has a valid free open-source (FOSS) license and a formal [release](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases).
14+
15+
You can run [`multiverse.internals::review_package()`](https://r-multiverse.org/multiverse.internals/reference/review_package.html) to check if your package is compliant.
16+
For example:
17+
18+
```r
19+
install.packages(
20+
"multiverse.internals",
21+
repos = c("https://community.r-multiverse.org", getOption("repos"))
22+
)
23+
multiverse.internals::review_package(
24+
name = "polars",
25+
url = "https://github.com/pola-rs/r-polars"
26+
)
27+
```
1328

14-
In addition, R-multiverse pulls R packages directly from
15-
[releases](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases) on GitHub and GitLab.
16-
Before contributing a package to R-multiverse, please ensure it is available
17-
in a public GitHub/GitLab source code repository with at least one
18-
[release](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases) ([example](https://github.com/pola-rs/r-polars/releases/tag/v0.21.0)).
29+
Not all findings are problems, but some may delay the acceptance of your package.
1930

2031
## Registration
2132

moderators.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,9 @@ If you have a question, please post a discussion to <https://github.com/r-multiv
9797

9898
The role of a [moderator](governance.md#moderator) is to read contributions at <https://github.com/r-multiverse/contributions/pulls>, merge the pull requests that comply with [R-multiverse official policies](policies.md), and either close the pull request (without merging) or ask for changes in non-compliant cases.
9999

100+
When the bot triggers manual review, please run [`multiverse.internals::review_package()`](https://r-multiverse.org/multiverse.internals/reference/review_package.html) on each of the submitted packages.
101+
This function runs the [list of automated pre-registration checks](review.md#automatic-acceptance).
102+
100103
As a [moderator](governance.md#moderator), you may optionally restrict your review to packages in your area of expertise.
101104
Simply search [contributions](https://github.com/r-multiverse/contributions/pulls) for relevant keywords, including [R-multiverse topics](https://r-multiverse.org/topics/).
102105

0 commit comments

Comments
 (0)