Skip to content

Enforce the prefixing of comments more #1024 - #1035

Open
maelle wants to merge 9 commits into
mainfrom
prefixes
Open

Enforce the prefixing of comments more #1024#1035
maelle wants to merge 9 commits into
mainfrom
prefixes

Conversation

@maelle

@maelle maelle commented Aug 24, 2026

Copy link
Copy Markdown
Member

Fix #1024


Checklist for dev guide maintainers, do not delete 😸

  • Review of the content in the initial language.
  • News item.
  • Translation of the content in other languages.
  • Review of the translations.

@maelle
maelle requested a review from mpadge August 24, 2026 09:04
@github-actions
github-actions Bot temporarily deployed to pull request August 24, 2026 09:15 Inactive

@mpadge mpadge left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is a great enhancement. Thank you!

@maelle

maelle commented Aug 24, 2026

Copy link
Copy Markdown
Member Author

I'll now wait for feedback after asking about this in Slack.

@github-actions
github-actions Bot temporarily deployed to pull request August 24, 2026 14:20 Inactive
@github-actions
github-actions Bot temporarily deployed to pull request August 25, 2026 08:21 Inactive
Comment thread softwarereview_editor.Rmd Outdated
Co-authored-by: Joel Nitta <joelnitta@gmail.com>
@github-actions
github-actions Bot temporarily deployed to pull request August 26, 2026 06:50 Inactive
@github-actions
github-actions Bot temporarily deployed to pull request August 31, 2026 12:54 Inactive
@maelle
maelle requested review from a team as code owners August 31, 2026 13:08
@maelle
maelle requested review from fblpalmeira and yabellini and removed request for a team August 31, 2026 13:08
Comment thread softwarereview_author.es.Rmd Outdated
- Mientras se revisa tu paquete, por favor, no hagas ningún cambio, salvo las correcciones urgentes. De hecho, los revisores deben poder revisar la última versión (la mejor hasta ahora) de tu software, y esa versión no debería cambiar.
- Te pedimos que respondas a estos comentarios en un plazo máximo de 2 semanas desde la última revisión presentada, pero puedes actualizar tu paquete o responder en cualquier momento. Tu respuesta debe incluir un enlace a la actualización del archivo [*NEWS.md*](#news) de tu paquete. Aquí tienes [un ejemplo de respuesta](https://github.com/ropensci/software-review/issues/593#issuecomment-1714421144). Una vez hayas respondido, [enviala a nuestra base de datos usando nuestro bot](#submit-response-to-reviewers). Animamos a la continuación de conversaciones entre autores y revisores. Consulta la [guía de revisión](#reviewerguide) para más detalles.
- Te pedimos que respondas a estos comentarios en un plazo máximo de 2 semanas desde la última revisión presentada, pero puedes actualizar tu paquete o responder en cualquier momento. Tu respuesta debe incluir un enlace a la actualización del archivo [*NEWS.md*](#news) de tu paquete. Aquí tienes [un ejemplo de respuesta](https://github.com/ropensci/software-review/issues/593#issuecomment-1714421144). Una vez hayas respondido, [enviala a nuestra base de datos usando nuestro bot](#submit-response-to-reviewers). Si las personas que revisaron tu paquete [usaron prefijos](#prefixing) antes de sus comentarios, por ejemplo, ml01, ml02, úsalos también en tu respuesta.
- Animamos a la continuación de conversaciones entre autores y revisores. Consulta la [guía de revisión](#reviewerguide) para más detalles.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
- Animamos a la continuación de conversaciones entre autores y revisores. Consulta la [guía de revisión](#reviewerguide) para más detalles.
- Animamos a continuar las conversaciones entre las personas autoras y revisoras. Consulta la [guía de revisión](#reviewerguide) para más detalles.

Comment thread softwarereview_author.Rmd Outdated
- While your package is under review, please refrain from making any change, apart from hot fixes. Indeed, reviewers should be able to review the latest (best until now) version of your software, and that version should not be changing.
- We ask that you respond to reviewers' comments within 2 weeks of the last-submitted review, but you may make updates to your package or respond at any time. Your response should include a link to the updated [NEWS.md](#news) of your package. Here is [an author response example](https://github.com/ropensci/software-review/issues/160#issuecomment-355043656). Once the response is commited, [submit it using the bot](#submit-response-to-reviewers). We encourage ongoing conversations between authors and reviewers. See the [reviewing guide](#reviewerguide) for more details.
- We ask that you respond to reviewers' comments within 2 weeks of the last-submitted review, but you may make updates to your package or respond at any time. Your response should include a link to the updated [NEWS.md](#news) of your package. Here is [an author response example](https://github.com/ropensci/software-review/issues/160#issuecomment-355043656). Once the response is commited, [submit it using the bot](#submit-response-to-reviewers). If reviewers [used prefixes](#prefixing) before their comments e.g. ml01, ml02, use them in your response as well.
- We encourage ongoing conversations between authors and reviewers. See the [reviewing guide](#reviewerguide) for more details.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can you clarify what this means?
The automatic translation is bad, and I don't know if this means that we encourage people to continue chatting after the review...or what do we try to mean here...

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

That they can talk in the issue outside of the review and the response if needed. How can I make this clearer?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hehe, many times I don't like my own writing after a while... 😸 😅

So, this mean that people can talk about the review in other places, like Slack?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

no, that they can write comments in the issue to have a conversation, that they don't need to communicate only through the review + the author response + the reviewers response

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Something like this?

We encourage authors and reviewers to keep the conversation going in the issue comments when needed. You don't have to limit the discussion to the formal review and the responses cycle. See the reviewing guide for more details.

Animamos a las personas autoras y revisoras a que usen los comentarios del issue para mantener el diálogo cuando sea necesario. No es necesario limitar el debate al ciclo formal de revisión y respuestas. Consulta la guía de revisión para obtener más detalles.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

perfect, thanks a ton

@yabellini yabellini left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I need clarification on the English version to be able to edit the spanish one.

@maelle

maelle commented Sep 1, 2026

Copy link
Copy Markdown
Member Author

Thank you @yabellini! (For the record, that sentence was already in the guide before the edit, but I'm putting it in its own item to make space for the thing I am adding 😅 I am however happy for us to improve that text, excellent opportunity to clarify it)

@github-actions
github-actions Bot temporarily deployed to pull request September 1, 2026 13:58 Inactive
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.

Enforce the prefixing of comments more

4 participants