Overall task tracking and roadmap

[lwjohnst86]

Check out the Project Board to have a bigger picture overview of what needs to be done, what needs to be reviewed, and who works on what.

Who does what

• preamble/syllabus.qmd: @lwjohnst86
• sessions/automated-testing.qmd: @signekb
• sessions/creating-website.qmd: @omarsilverman
• sessions/debugging.qmd: @Aastedet
• sessions/documenting-functions.qmd: @AndersAskeland
• sessions/function-development.qmd: @AndersAskeland
• sessions/introduction.qmd: @lwjohnst86
• sessions/package-setup.qmd: @lwjohnst86
• sessions/testing.qmd: @signekb
• sessions/what-next.qmd: @lwjohnst86
• sessions/writing-guides.qmd: ?
• appendix/project.qmd: @lwjohnst86

General roadmap

This timeline is assuming maybe 2-3 days of work a month, potentially less.

• Reading through current session material, learning about your session's topic (starting with R Packages), learning to use Pull Requests to contribute, and write/revise a basic draft of session-specific learning objectives
• Continue learning about your session's topic, get your learning objectives reviewed and then refine them
• Start creating exercises that will achieve the learning objectives, ~2-4 exercises per session
• Continue refining exercises, get them reviewed and refine them
• Fill in all the prerequisite material needed to complete each exercise
• Edit, revise, and review the entire course material
• Run the course somewhere?

Contributing tips

• In general, create a pull request for each milestone (e.g. after finishing your learning objective, submit a Pull Request). Fewer changes made per Pull Request (a "small PR") are easier to review, approve, and merge, so in general make fewer changes for every PR.

• If using RStudio, use the usethis::pr_* helper workflow. See the instructions on the usethis package website. The functions to use would be:

  # Make sure to have a GitHub Token created:
  # usethis::create_github_token()
  
  # Add the token so R knows about it
  gitcreds::gitcreds_set()
  
  # Create a new branch
  pr_init("name-of-new-branch")
  
  # Make and commit changes
  
  # Push your changes to GitHub and make a Pull Request
  pr_push()
  
  # Fill in the details of the Pull Request page that opened up
  
  # Stop work on your local branch by moving back to the main branch
  pr_pause()
  
  # After your PR has been merged, run these two commands
  pr_resume() 
  # Select your branch that was just merged
  pr_finish()