Skip to content

Commit

Permalink
Update terms.qmd for improved clarity (#80)
Browse files Browse the repository at this point in the history
  • Loading branch information
YaoxiangLi authored Dec 16, 2024
1 parent 794caa8 commit dbc1681
Showing 1 changed file with 32 additions and 32 deletions.
64 changes: 32 additions & 32 deletions publish/terms.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,45 +4,45 @@ title: "Package publishing rules"

## Avoid name collisions

While it is technically possible to host a fork or completely different package with the same name in a universe,
we strongly recommend your **not** doing it.
While it is technically possible to host a fork or a completely different package with the same name in a universe, this practice is **strongly discouraged**.

- An user might mistakenly install the `example` package from CRAN rather than the version from an universe.
R will automatically overwrite one package with the other when running `install.packages()` or `update.packages()`.
- It becomes even trickier when other packages import the package.

Therefore, when two packages have the same name, and one of them is on CRAN, R-universe:
- treats the one that is on CRAN as the official version.
- warns users against the duplication on the page of the other package.
- Users might accidentally install the `example` package from CRAN instead of the intended version from a universe.
- R will overwrite one package with the other when running `install.packages()` or `update.packages()`.
- This issue becomes more problematic when other packages depend on the conflicting package.

To address this, R-universe:
- Treats the CRAN version as the official package.
- Warns users about the duplication on the page of the conflicting package.

## Reserved names

The following names should be avoided as package name because `https://username.r-universe.dev/{pkg}/` has special meaning:

- api
- apis
- articles
- badges
- bin
- builds
- citation
- contributors
- datasets
- docs
- favicon.ico
- feed.xml
- index.xml
- manual
- packages
- readme
- robots.txt
- sitemap_index.xml
- sitemap.xml
- src
- stats
Avoid using the following names for packages, as they have special meanings in R-universe URLs (`https://username.r-universe.dev/{pkg}/`):

- `api`
- `apis`
- `articles`
- `badges`
- `bin`
- `builds`
- `citation`
- `contributors`
- `datasets`
- `docs`
- `favicon.ico`
- `feed.xml`
- `index.xml`
- `manual`
- `packages`
- `readme`
- `robots.txt`
- `sitemap_index.xml`
- `sitemap.xml`
- `src`
- `stats`

## Code of Conduct

Maintainers of universes are solely responsible for their projects.
Universe maintainers are solely responsible for the projects in their universes.

The R-universe project itself is governed by the [rOpenSci code of conduct](https://ropensci.org/code-of-conduct/).

0 comments on commit dbc1681

Please sign in to comment.