Skip to content

mention NEWS.md file in packaging guide #1034

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maelle merged 3 commits into from
Aug 25, 2026
+13 −0
Merged

mention NEWS.md file in packaging guide #1034

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1f4192d
mention `NEWS.md` file in packaging guide
maelle Aug 24, 2026
e0a56bb
translations
maelle Aug 24, 2026
ba95271
Merge branch 'main' into changelog
maelle Aug 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions booknews.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## Dev version

- 2026-08-24, mention `NEWS.md` file in packaging guide (#1027).
- 2026-06-26, explicitely state that authors should not change their package while it is under review (#1022).
- 2026-06-25, add note for editors that authors should record their responses (#1021, `@robitalec`)
- 2026-06-12, clarify expections for volunteer form for eds and revs (#1015; thanks to `@joelnitta`)
Expand Down
4 changes: 4 additions & 0 deletions pkg_building.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -564,6 +564,10 @@ For how to update your DESCRIPTION file, see the [R packages book](https://r-pkg

- A later section of this book contains some [git workflow tips](#git-workflow).

## Changelog

Your package should contain a [`NEWS.md` file](#news).
Comment thread
mpadge marked this conversation as resolved.

## Miscellaneous CRAN gotchas {#crangotchas}

This is a collection of CRAN gotchas that are worth avoiding at the outset.
Expand Down
4 changes: 4 additions & 0 deletions pkg_building.es.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -562,6 +562,10 @@ Para saber cómo actualizar tu archivo DESCRIPTION, consulta el libro [*R packag

- Una sección posterior de este libro incluye algunos [consejos sobre el flujo de trabajo con git](#git-workflow).

## Registro de cambios

Tu paquete debería contener un [archivo`NEWS.md`](#news).

## Problemas comunes en CRAN {#crangotchas}

Esta es una colección de problemas en CRAN que vale la pena evitar desde el principio.
Expand Down
4 changes: 4 additions & 0 deletions pkg_building.pt.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,6 +488,10 @@ a sustentabilidade de longo prazo do seu pacote. Isso também

- Uma seção posterior deste livro contém algumas [dicas de fluxo de trabalho com git](#git-workflow).

## Registro de alterações

Seu pacote deve conter um [arquivo `NEWS.md`](#news).

## Problemas diversos do CRAN {#crangotchas}

Esta é uma coleção de problemas do CRAN que vale a pena evitar desde o início.
Expand Down