Skip to content

Conversation

@ShinoYumi
Copy link
Contributor

I am submitting

  • a new package
  • an update for a package

Description: Official thesis template for University of Defence

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.

@typst-package-check typst-package-check bot added the new A new package submission. label Oct 17, 2025
@elegaanz elegaanz self-assigned this Oct 21, 2025
Copy link
Member

@elegaanz elegaanz left a comment

Choose a reason for hiding this comment

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

I left a few comments that would need to be fixed before this package can be published. Also, it would be nice if you could fix the warnings about kebab-case variable names, as this is the most common naming convention in the Typst ecosystem.

Copy link
Member

Choose a reason for hiding this comment

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

It is not possible to ship fonts with package. Please remove these files and explain in your README (and/or in a comment in the template source code) how to download and use them with Typst.

repository = "https://github.com/ShinoYumi/unob-thesis"
keywords = [ "Závěrečná práce", "UNOB", "Univerzita obrany" ]
categories = [ "thesis" ]
compiler = "0.14.0"
Copy link
Member

Choose a reason for hiding this comment

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

This field is for the minimum supported compiler version. Unless you depend on features of the upcoming release, you should lower this number or remove it entirely. If you do depend on new features, we will have to wait for the official release before publishing this package.

entrypoint = "src/lib.typ"
authors = [ "ShinoYumi <https://github.com/ShinoYumi>" ]
license = "MIT"
description = "Oficiální a plně vybavená šablona v sázecím systému Typst, určená pro tvorbu bakalářských, diplomových a disertačních prací na Univerzitě obrany. Byla navržena tak, aby maximálně zjednodušila formátování, automatizovala generování povinných částí a zajistila 100% soulad s oficiálními směrnicemi."
Copy link
Member

Choose a reason for hiding this comment

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

This description is a bit long, can you rephrase it, please? We also prefer to have them in English, to make it understandable by more people. In general, you can refer to these guidelines to write good package descriptions.

@@ -0,0 +1,21 @@
[package]
name = "unob-thesis"
Copy link
Member

Choose a reason for hiding this comment

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

Because this package is not official, I will ask you to change its name to something more unique. It should be clear by looking at the name that it is maintained by a community member and not officially endorsed by the university. See our rules on package naming if you want to be sure you meet our guidelines.

Copy link
Member

Choose a reason for hiding this comment

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

Your thumbnail should show how a document that uses your template looks like.

@@ -0,0 +1,210 @@
# Šablona pro závěrečné práce (Univerzita obrany)

Tento dokument slouží jako komplexní manuál a průvodce pro používání šablony `unob-thesis` v prostředí Typst.
Copy link
Member

Choose a reason for hiding this comment

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

Can you add at least one sentence in English at the beginning of the README, so that everyone is able to understand what this template is about?

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.

2 participants