Simulation-Software-Engineering / Simulation-Software-Engineering/Lecture-Material

Automation: Integrate pre-commit into the slides and exercise

Open
#268 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
63
Forks
70
Avg merge
8d 18h
Merged PRs (30d)
1

Description

This year, I showed pre-commit only briefly, but it would be interesting to integrate it in the content.

We should then make the CI exercise call pre-commit. This would be particularly useful for RSE-102.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the slides and CI exercise for RSE-102, then review how the exercise currently runs in CI. Integrate pre-commit into the lecture content and make the CI exercise call it; done means both the slides and exercise demonstrate the workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
git
Domain
ci-cd, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.