Skip to content

Show both maintainers in pkgdown sidebar#65

Merged
fcorowe merged 4 commits into
mainfrom
add-carmen-maintainer
Jun 15, 2026
Merged

Show both maintainers in pkgdown sidebar#65
fcorowe merged 4 commits into
mainfrom
add-carmen-maintainer

Conversation

@carmen-cabrera

@carmen-cabrera carmen-cabrera commented Jun 13, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • keep DESCRIPTION valid with a single cre package maintainer, as required by R package metadata rules
  • customize the pkgdown homepage Developers sidebar so Francisco Rowe and Carmen Cabrera are both displayed as “Author, maintainer”

Why

R packages can only list one person with the cre maintainer role in Authors@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)
  • inspected /private/tmp/debiasr-maintainer-preview/index.html and confirmed the homepage Developers sidebar lists both Francisco Rowe and Carmen Cabrera as “Author, maintainer”

@carmen-cabrera carmen-cabrera requested a review from fcorowe as a code owner June 13, 2026 15:07
@carmen-cabrera carmen-cabrera changed the title Add Carmen Cabrera as maintainer Show both maintainers in pkgdown sidebar Jun 13, 2026
@fcorowe

fcorowe commented Jun 13, 2026

Copy link
Copy Markdown
Collaborator

According to the official ⁠CRAN Repository Policy, an R package must show both the name and email address of a single designated maintainer.

@carmen-cabrera

Copy link
Copy Markdown
Collaborator Author

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.

fcorowe commented Jun 15, 2026

Copy link
Copy Markdown
Collaborator

Thanks, Carmen. I agree with the approach of keeping this as a pkgdown-only display change rather than changing DESCRIPTION.

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 Authors@R with the cre role and an email address. Since Francisco remains the only cre maintainer in DESCRIPTION, I suggest avoiding the same plain “maintainer” label for both people in the pkgdown sidebar.

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.

@carmen-cabrera

Copy link
Copy Markdown
Collaborator Author

@fcorowe agree your suggestion! Feel free to make the suggested changes and commit them to this branch.

@carmen-cabrera

Copy link
Copy Markdown
Collaborator Author

Looks good @fcorowe - feel free to merge into main

@fcorowe fcorowe left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved. The final wording keeps DESCRIPTION CRAN-safe while documenting both project roles on the pkgdown site.

@fcorowe fcorowe merged commit ec7a5b6 into main Jun 15, 2026
3 checks passed
@fcorowe fcorowe deleted the add-carmen-maintainer branch June 15, 2026 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants