Show both maintainers in pkgdown sidebar#65
Conversation
|
According to the official CRAN Repository Policy, an R package must show both the name and email address of a single designated maintainer. |
|
Agreed. For package metadata, just one maintainer is allowed. But the display on the vignettes can be customised to add more than one. See description above. |
|
Thanks, Carmen. I agree with the approach of keeping this as a pkgdown-only display change rather than changing One small wording tweak would make this clearer and safer with respect to CRAN conventions. CRAN package metadata expects a single designated package maintainer in Could we update the sidebar text to distinguish the formal package maintainer role from broader project maintenance, for example: Francisco Rowe<br>
<small class="roles">Author, package maintainer</small><br><br>
Carmen Cabrera<br>
<small class="roles">Author, project maintainer</small>That keeps the intent of the PR, recognises both roles on the documentation site, and avoids implying that the package has two CRAN/DESCRIPTION maintainers. Leaving this PR open for that wording change. |
|
@fcorowe agree your suggestion! Feel free to make the suggested changes and commit them to this branch. |
|
Looks good @fcorowe - feel free to merge into main |
fcorowe
left a comment
There was a problem hiding this comment.
Approved. The final wording keeps DESCRIPTION CRAN-safe while documenting both project roles on the pkgdown site.
Summary
DESCRIPTIONvalid with a singlecrepackage maintainer, as required by R package metadata rulesWhy
R packages can only list one person with the
cremaintainer role inAuthors@R. Both Francisco and Carmen maintain the project, so this PR uses pkgdown display customization to show both maintainers on the documentation website without breaking package installation or checks.Verification
R CMD INSTALL .pkgdown::build_home(pkg = ".", override = list(destination = "/private/tmp/debiasr-maintainer-preview"), quiet = TRUE)/private/tmp/debiasr-maintainer-preview/index.htmland confirmed the homepage Developers sidebar lists both Francisco Rowe and Carmen Cabrera as “Author, maintainer”