search

merely-useful / r-rse

ARCHIVED: Activity moved to rostools organization.
Other
11 stars 5 forks source link

Progress tracking and assigned chapters #23

Closed lwjohnst86 closed 1 year ago

lwjohnst86 commented 3 years ago

This issue will be used as the main reference to what needs to be completed and what phase we're at. We also put who is responsible for what chapter/content. Multiple people can assign themselves to individual chapters.

When a person's assigned chapter has been modified in a Pull Request, they will be automatically added as reviewers because of the CODEOWNERS feature of GitHub.

Who is assigned what for chapters and appendices

Chapter/appendix Primary Secondary
appendices/assignments.md @lwjohnst86
chapters/01-preface.Rmd @lwjohnst86 @k8hertweck
chapters/02-filesystem.Rmd @k8hertweck @mbonsma
chapters/03-package-setup.Rmd @lwjohnst86 @cwickham
chapters/04-function-development.Rmd @cwickham @k8hertweck
chapters/05-version-control-solo.Rmd @k8hertweck
chapters/06-code-correctness.Rmd @cwickham @lwjohnst86
chapters/07-build-management.Rmd @lwjohnst86 @cwickham
chapters/08-documentation.Rmd @mbonsma @ian-flores
chapters/09-package-website.Rmd @mbonsma @cwickham
chapters/10-community-involvement.Rmd @mbonsma @k8hertweck
chapters/11-version-control-workflow.Rmd @lwjohnst86
chapters/12-package-release.Rmd @cwickham
chapters/13-team-package-dev.Rmd @mbonsma @lwjohnst86
chapters/14-conclusion.Rmd @k8hertweck everyone :grin:

Progress tracking

Completed project assignments (item 2 in #1)

Completed chapter final exercises (item 3 in #1)

These are only to be rough drafts, we will edit them as we complete them.

First review phase

See #59. Done by:

Completed steps/actions taken on example package (item 4 in #1)

List out the steps or actions taken or functions used (e.g. usethis) throughout each chapter that builds up the example package (Zipfs Law). Add learning objectives to the top of the chapter file that will link the steps taken and exercises.

Completed core (and supplemental) exercises done with the example package (item 5 in #1)

Write out some core and supplemental exercises that build up or add to the example package (Zipfs Law) within each chapter. Include potential solutions in the exercise section as it's own code chunk. Exercises should be inserted below their respective steps from item 4 of #1 (section above).

This depends heavily on the chapter, but a good aim for number of exercises would be between 6-12.

Draft of packages used throughout book (item 6 in #1)

Done by @cwickham and @ian-flores. See #54 and #55, or:

Add content and create rough draft of each chapter (item 7 in #1)

Build up and finish writing the exercises and add the text and code-along content that are related to them.

As content and exercises are added, please refer to #96 for more details on how to format and structure the chapters.

mbonsma commented 3 years ago

Chapters I feel (somewhat) comfortable working on:

k8hertweck commented 3 years ago

I'd be best suited to work on any of the following chapters:

chapters/01-syllabus.Rmd chapters/02-filesystem.Rmd chapters/05-version-control-solo.Rmd chapters/10-community-involvement.Rmd chapters/11-version-control-workflow.Rmd chapters/12-project-management.Rmd chapters/14-team-package-dev.Rmd

cwickham commented 3 years ago

Taking into account some places that it looks like @k8hertweck and @mbonsma have covered, I'm happy with any of: chapters/03-package-setup.Rmd chapters/04-function-development.Rmd chapters/06-code-correctness.Rmd chapters/07-build-management.Rmd chapters/09-package-website.Rmd chapters/13-package-release.Rmd

cwickham commented 3 years ago

To get the ball rolling, I've snagged chapters/03-package-setup.Rmd.

ian-flores commented 3 years ago

Hey folks, sorry for the delay. I'd prefer to contribute with the following chapters:

But I also feel comfortable contributing to any chapter as needed.

lwjohnst86 commented 3 years ago

great, thanks all. I'll compare the differences and assign people to chapters before next meeting.

lwjohnst86 commented 3 years ago

I've updated who's assigned to which chapter and I've also put each person with a primary chapter and a secondary chapter (so you would be responsible for reviewing, bouncing ideas of, etc). So far, each person has about 3 chapters for primary and two-three chapters as secondary.