Skip to content

tf-freiburg-thesis:0.1.0#5033

Open
Arturjssln wants to merge 1 commit into
typst:mainfrom
Arturjssln:tf-freiburg-thesis-0.1.0
Open

tf-freiburg-thesis:0.1.0#5033
Arturjssln wants to merge 1 commit into
typst:mainfrom
Arturjssln:tf-freiburg-thesis-0.1.0

Conversation

@Arturjssln

@Arturjssln Arturjssln commented Jun 11, 2026

Copy link
Copy Markdown

I am submitting

  • a new package
  • an update for a package

Description: Explain what the package does and why it's useful.

I have read and followed the submission guidelines and, in particular, I

  • selected a name that isn't the most obvious or canonical name for what the package does
  • added a typst.toml file with all required keys
  • added a README.md with documentation for my package
  • have chosen a license and added a LICENSE file or linked one in my README.md
  • tested my package locally on my system and it worked
  • excluded PDFs or README images, if any, but not the LICENSE
  • ensured that my package is licensed such that users can use and distribute the contents of its template directory without restriction, after modifying them through normal use.

Copilot AI review requested due to automatic review settings June 11, 2026 13:16
@Arturjssln Arturjssln force-pushed the tf-freiburg-thesis-0.1.0 branch from abf655a to 3caa815 Compare June 11, 2026 13:18
@typst-package-check typst-package-check Bot added the new A new package submission. label Jun 11, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread packages/preview/tf-freiburg-thesis/0.1.0/src/main.typ Outdated
Comment thread packages/preview/tf-freiburg-thesis/0.1.0/src/main.typ
Comment thread packages/preview/tf-freiburg-thesis/0.1.0/src/main.typ Outdated
Comment thread packages/preview/tf-freiburg-thesis/0.1.0/src/main.typ Outdated
Comment thread packages/preview/tf-freiburg-thesis/0.1.0/README.md Outdated
Comment thread packages/preview/tf-freiburg-thesis/0.1.0/LICENSE Outdated
@Arturjssln Arturjssln force-pushed the tf-freiburg-thesis-0.1.0 branch from 3caa815 to 82a777b Compare June 11, 2026 13:35
@Arturjssln Arturjssln force-pushed the tf-freiburg-thesis-0.1.0 branch from 82a777b to 2bbeb1f Compare June 11, 2026 13:40
@Arturjssln Arturjssln force-pushed the tf-freiburg-thesis-0.1.0 branch from 2bbeb1f to 4c01fe4 Compare June 11, 2026 13:55
@elegaanz elegaanz self-assigned this Jun 11, 2026

@elegaanz elegaanz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for submitting this template!


## License and Assets

This repository is licensed as CC BY 4.0, matching `typst.toml`.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you verify that you were allowed to distribute these logos?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new A new package submission.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants