Software Engineering lecture material.
Material is based on Polyglot notebooks is in Jupyter Notebook format ipynb. It allows to blend formatted text with the executable code. ipynb itself is a json format document, which is best read in an editor with dedicated support. Recommendation is to use VS Code with a few extensions as described in the section. Read more about this here https://github.com/dotnet/interactive/blob/main/docs/FAQ.md.
Suggested approach is to use VS Code with the following extensions:
If you would like to contribute but unsure on what exactly: take a look at Issues section on GitHub - https://github.com/smagurauskas/software-engineering/issues. Here are the currently relevant issues are tracked. If you would like to start working one, then post about it in the issue comments.
Pull requests are welcome. Few things to keep in mind when contributing:
- Do not change the general lecture structure like order of the lectures or top-level parts of the notebooks.
- Text should be in passive tense where possible.
- Use mermaid diagrams instead of image diagrams if possible.
- It should be possible to use notebooks as slides using
nbconvert. It relies on correct slide type assigned to each cell as well as content in cell being relatively small. If the cell is too big to be displayed as a slide on screen, then consider splitting it into smaller cells instead. - Do not commit cell output.
- Prefer open source examples and tools where possible.
To launch the notebook in slide mode use this command:
jupyter nbconvert <notebook file name> --to slides --post serve --no-input --no-prompt
However this relies that all the cells would have proper slide type assigned to them. If slide does not have a slide type assigned, then whole notebook conversion might fail in interesting ways.
It is known that mermaid diagrams not always convert to slides properly on the first go. Refreshing the browser at location of the slide for few times usually helps.
Add the following filter to git config:
git config filter.strip-notebook-output.clean 'jupyter nbconvert --ClearOutputPreprocessor.enabled=True --to=notebook --stdin --stdout --log-level=ERROR'