tf-freiburg-thesis:0.1.0#5033
Conversation
abf655a to
3caa815
Compare
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds a new Typst package (tf-freiburg-thesis v0.1.0) providing a Freiburg Faculty of Engineering thesis layout plus a typst init starter template and bundled assets.
Changes:
- Introduces the package manifest (
typst.toml) and core implementation (src/main.typ) with layout, title pages, sidenotes, citations, and helper blocks. - Adds a complete starter project under
src/template/(thesis entrypoint, chapter skeletons, bibliography). - Bundles University of Freiburg logo assets and adds package documentation/license files.
Reviewed changes
Copilot reviewed 15 out of 20 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/preview/tf-freiburg-thesis/0.1.0/typst.toml | Defines package metadata and template entrypoint for Typst Universe. |
| packages/preview/tf-freiburg-thesis/0.1.0/src/main.typ | Core thesis layout + exported helpers (sidenotes, todos, citations, title pages). |
| packages/preview/tf-freiburg-thesis/0.1.0/src/template/thesis.typ | Starter template showing how to configure and use thesis.with(...). |
| packages/preview/tf-freiburg-thesis/0.1.0/src/template/references.bib | Sample bibliography entries for the starter project. |
| packages/preview/tf-freiburg-thesis/0.1.0/src/template/content/1_introduction.typ | Example introduction chapter content for the starter project. |
| packages/preview/tf-freiburg-thesis/0.1.0/src/template/content/2_related_work.typ | Example related work chapter content + citation usage guidance. |
| packages/preview/tf-freiburg-thesis/0.1.0/src/template/content/3_background.typ | Example background chapter content. |
| packages/preview/tf-freiburg-thesis/0.1.0/src/template/content/4_methodology.typ | Example methodology chapter content + template structure explanation. |
| packages/preview/tf-freiburg-thesis/0.1.0/src/template/content/5_experiments.typ | Rich examples demonstrating formatting, math, figures, algorithms, and draft helpers. |
| packages/preview/tf-freiburg-thesis/0.1.0/src/template/content/6_discussion.typ | Example discussion/future work/conclusion chapter content. |
| packages/preview/tf-freiburg-thesis/0.1.0/src/template/content/A_appendix.typ | Example appendix content (incl. AI assistance note). |
| packages/preview/tf-freiburg-thesis/0.1.0/src/assets/template/logo-freiburg/20221107-UFR-logo-white-rgb-FFFFFF.svg | Bundled Freiburg logo asset (white variant). |
| packages/preview/tf-freiburg-thesis/0.1.0/src/assets/template/logo-freiburg/20221107-UFR-logo-black-rgb-000000.svg | Bundled Freiburg logo asset (black variant). |
| packages/preview/tf-freiburg-thesis/0.1.0/src/assets/template/logo-freiburg/20221026-UFR-wortmarke-grundform_Blau_RGB.svg | Bundled Freiburg logo asset (blue variant), used by default logo selection. |
| packages/preview/tf-freiburg-thesis/0.1.0/README.md | Package usage and configuration documentation. |
| packages/preview/tf-freiburg-thesis/0.1.0/LICENSE | Declares package license in-repo. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
3caa815 to
82a777b
Compare
82a777b to
2bbeb1f
Compare
2bbeb1f to
4c01fe4
Compare
elegaanz
left a comment
There was a problem hiding this comment.
Thank you for submitting this template!
|
|
||
| ## License and Assets | ||
|
|
||
| This repository is licensed as CC BY 4.0, matching `typst.toml`. |
There was a problem hiding this comment.
This is not true, your manifest and license file say MIT.
| package, verify that your use of those assets follows the University of | ||
| Freiburg's current brand and usage rules. | ||
|
|
||
| ## Publishing |
There was a problem hiding this comment.
Developer specific instructions such as this sections are generally discouraged from Typst Universe README, as they are at best noise for package users, and at worse a source of confusion. I would recommend removing it (but it's not mandatory, and if you prefer to not maintain two distinct versions of the README you can also keep it).
| @@ -0,0 +1,18 @@ | |||
| [package] | |||
| name = "tf-freiburg-thesis" | |||
There was a problem hiding this comment.
If this isn't an official package of the university, could you pick another name please? It should be distinctive enough so that another package with the same purpose can be published without one of the two having an unfair advantage, and it should be clear from the name that it is community-built and not officially endorsed by the university. See our naming rules.
If you want to make this an official template, to keep the current name, that's also an option. In that case a member of the University staff should send an email to hello@typst.app stating that they officially endorse your package. In practice it means that they will accept submission of works built using it, and ideally promote it and guarantee that it will be maintained in the long term.
|
|
||
| // Main content chapters | ||
| pagebreak() | ||
| for chapter-content in chapters { |
There was a problem hiding this comment.
In the end the API design is up to you, but if I may give my opinion, I'm not sure this is brings any benefit compared to just having the include statements directly in the body. It would be more idiomatic and similar to other templates to remove the chapters argument.
|
|
||
| This repository is licensed as CC BY 4.0, matching `typst.toml`. | ||
|
|
||
| The Freiburg logo and seal assets in `src/assets/template/logo-freiburg/` are |
There was a problem hiding this comment.
Did you verify that you were allowed to distribute these logos?
I am submitting
Description: Explain what the package does and why it's useful.
I have read and followed the submission guidelines and, in particular, I