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

Automate testing and publishing #41

Open
MaybeJustJames opened this issue Feb 10, 2021 · 1 comment
Open

Automate testing and publishing #41

MaybeJustJames opened this issue Feb 10, 2021 · 1 comment
Labels
enhancement New feature or request

Comments

@MaybeJustJames
Copy link
Member

MaybeJustJames commented Feb 10, 2021

Store a single source format from which the following can be generated:

  • Jupyter Notebooks as they currently exist (with room for students to fill in exercise solutions) and solved notebooks
  • Pure python code extracted from code cells that can be tested in CI (including expected failures/exceptions)
  • Possibly quiz slides
  • Possibly markdown for the training website

There are 2 motivations for this:

  1. Reduce the risk of mistakes in the course material.
  2. This course should encourage and exemplify good software engineering practice. Testing is an important part of software engineering practice. Therefore this course should employ testing, even if it is invisible to students.

A possible solution could look like the PureScript Book which is checked in CI. It is distributed with NoPeeking solutions that can be tested (allowing problems and exercises to be reviewed).

@MaybeJustJames
Copy link
Member Author

MaybeJustJames commented Jan 7, 2022

Some tools that might be useful:

@MaybeJustJames MaybeJustJames added the enhancement New feature or request label Apr 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant