Skip to content
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.

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

Some more comments on the draft #55

Open
MichaelChirico opened this issue Dec 19, 2023 · 0 comments
Open

Some more comments on the draft #55

MichaelChirico opened this issue Dec 19, 2023 · 0 comments

Comments

@MichaelChirico
Copy link
Contributor

MichaelChirico commented Dec 19, 2023

Not sure the right way to make suggestions without strictly committing to an edit for a PR. So filing this issue with comments on permalinked source. Happy to file a PR with accepted suggestions/adjustments, starting here for discussion.


infrastructure supporting contribution. Several small tasks were completed

Maybe drop "small"? I worry it might diminish the work that got completed, some of which was low-hanging fruit but some of which I would shy from calling "small", though it is definitely "relatively small" compared to those tasks where significant headway was made without reaching the finish line. How about

Several tasks were completed during the sprint itself. Some larger projects saw significant progress as well.

https://github.com/r-devel/rcwg/blob/main/r_project_sprint/report/r-project-sprint-2023-report.Rmd#L13-L15

A bit repetitive "development"/"develop", "contributors"/"contribution". Maybe

The event provided a unique opportunity for external programmers to learn about the R development process and to further their contribution skills.

on Day 2 and Day 3 of the sprint, a full [list of participants](https://contributor.r-project.org/r-project-sprint-2023/participants/) is on the sprint website. Participation was in-person by default,

Here and a sporadically below, the line is very wide, so it's harder to read in plaintext. It doesn't matter for the rendered version.

travel disruptions; in the end seven people participated online.

Nit: elsewhere, numbers are digits, here it's spelled out. For consistency 'seven' -> '7'.

https://github.com/r-devel/rcwg/blob/main/r_project_sprint/report/r-project-sprint-2023-report.Rmd#L133-L135

Nit: the two 'and' are a bit hard to parse, maybe

including the R Blog post on reviewing bugs, the useR! 2021 tutorial on analysing bugs/contributing patches, and the useR 2021! tutorial on translating messages in R.

Or

including the useR! 2021 tutorials on analysing bugs/contributing patches and translating messages and the R Blog post on reviewing bugs.

the [R Dev Guide](https://contributor.r-project.org/rdevguide/) and the

Does Coventry use the Oxford comma? :)

the [R Dev Guide](https://contributor.r-project.org/rdevguide/) and the
prototype [GitHub Codespace](https://github.com/r-devel/r-dev-env/) which
provides a virtual environment in which to build R - this was demonstrated in
one of the contributor office hours.

Grammar feels a bit off in the late part of the sentence, what about

People new to this were pointed to the R-admin manual, the R Dev Guide, and a prototype GitHub Codespace for building R which was demonstrated in one of the contributor office hours[^footnote].
[^footnote] GitHub Codespaces provide hosted Docker images so that anybody can use the same environment from anywhere, see https://github.com/features/codespaces.

On the second evening, in-person participants enjoyed a conference dinner, whilst on the final evening the sprint participants joined the Warwick R User Group for a hybrid meetup to present progress made thus far at the sprint, this was followed by a buffet dinner for in-person participants.

I would change 'this was followed' -> 'followed'. Possibly a UK/US thing.

including translation memory, hyperlinking to the source string location and

Add a phrase on "what is translation memory?"

dedicated reviewers to approve translations. New components were added, so that

Probably not clear what a component is? Maybe drop the phrase entirely?

The instance was extended so that it not only covers base R (messages, warnings, errors and the Windows GUI), but also the Mac GUI and recommended packages.

Windows GUI), but also the Mac GUI and recommended packages.

May not be clear to the audience "recommended" is a specific phrase here. Maybe "Recommended-priority packages" is better, or "Recommended-priority packages like Matrix" for even more context?

#| "end of spint and two months after.",

Typo: 'sprint'

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

No branches or pull requests

1 participant