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

Feat/exercises-for-testing-session #32

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

signekb
Copy link
Member

@signekb signekb commented Aug 7, 2024

Description

This PR adds exercises for the testing session.

Below is the tasks I need to do to accomplish this:

  • Add first iteration of exercise titles to be reviewed (I asked for a review in the comment below)
  • Finalise which exercises to include
  • Develop the exercises

Related issues

Closes #30

@signekb signekb self-assigned this Aug 7, 2024
@signekb
Copy link
Member Author

signekb commented Aug 8, 2024

@lwjohnst86 I have created the titles for three exercises for this session. I would like to know what you think about them before I flesh them out, so: what do you think? Some important aspects of the session that I've missed with these exercises? :)

@signekb
Copy link
Member Author

signekb commented Oct 15, 2024

@lwjohnst86 See the comment above (when you have the time) :)

Copy link
Member

@lwjohnst86 lwjohnst86 left a comment

Choose a reason for hiding this comment

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

Good first start 😁 I've given some comments!

To-Do: Explain the output of a CRAN check
TODO: Explain the output of a CRAN check

## Exercise: Create your first unit test
Copy link
Member

Choose a reason for hiding this comment

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

Ideally, we would go through creating a unit test first, and then they do it again on their own time. So it could be something like "Write a unit test to check for ABC". The exact details don't matter too much, as long as there is a general structure or steps.

Copy link
Member

Choose a reason for hiding this comment

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

This first exercise could even be something like "Review these example unit tests and identify the individual parts within and find out if they work as intended or not". So it could be more of a code reading exercise.

@@ -151,7 +152,7 @@ task, and pushing to GitHub.
TODO: Reading text
:::

## Exercise: TODO: Add title
## Exercise: TODO: Create unit tests for the remaining functions in your package
Copy link
Member

Choose a reason for hiding this comment

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

This is a bit too generic. It ideally would be a clear, explicit aim. If the first exercise is a code reading exercise, this one could be to create another unit test to check for some condition. Or even include a first task to ask them to select which condition to test for and then test it.

@@ -161,6 +162,19 @@ TODO: Reading text
#| code-summary: "**Click for the solution**. Only click if you are struggling or are out of time."
```

TODO: Reading text

## Exercise: TODO: Run a CRAN check on the package
Copy link
Member

Choose a reason for hiding this comment

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

As said above, we would ideally run this with them the first time. The exercise would be to do it on their own, after doing some changes or improving things.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

Create exercises for testing session
2 participants