Template Workshop

An opinionated template for making workshops as open educational resources

1 Welcome!

DOI Copier GitHub License GitHub Release Test Build website pre-commit.ci status lifecycle Project Status: Active – The project has reached a stable, usable state and is being actively developed.

This is a template for creating a new workshop with the intent of making it an open educational resource (OER). Use this template to quickly get started with a new workshop with all the necessary files and configurations in place, including for developing the workshop.

1.1 Features

  • Uses Quarto for the workshop content, allowing for easy integration of code, text, and figures.
  • Includes a justfile for managing common tasks like building the workshop and running checks.
  • Uses typos to check for common spelling mistakes.
  • For R projects, uses Air to format and check R code.
  • Uses Commitizen to check commit messages and automatically create the changelog.
  • Automated Git tagging and GitHub releases with commitizen that are based on messages following Conventional Commits.
  • Uses a CC-BY-4.0 license for the workshop content.
  • Run checks with with pre-commit hooks to ensure consistent formatting and style across the project. It includes checks for credentials, typos, and file formatting.
  • Uses the rostools-theme Quarto extension for a standard appearance across workshops.
  • Includes GitHub Actions for continuous integration, testing, and delivery for running checks, formatting, releasing, and building the website.
  • Uses Netlify for hosting the workshop website.
  • Includes an EditorConfig file to ensure consistent formatting across different editors.
  • High level, system and program management with uv.
  • GitHub workflows for automatically adding Pull Requests and Issues to a project board.
  • Pull Request template for easy creation of new Pull Requests.
  • VS Code settings commonly used by contributors working in VS Code.
  • .zenodo.json file for citation information, that provides Zenodo with the necessary metadata to create a DOI for the workshop.
  • Includes a GoatCounter file for website visitor tracking, which is privacy-friendly and does not use cookies. That means it doesn’t need a GDPR notice as no personal data is collected.

1.2 Want to contribute?

We would love your feedback or contributions! Head over to our GitHub repository or our contributing guide to share your ideas or contribute code. Your input makes us better!

1.2.1 Contributors

These are the people who have contributed by submitting changes through pull requests 🎉

@lwjohnst86, @signekb