-
Notifications
You must be signed in to change notification settings - Fork 741
unob-thesis:0.1.0 #3266
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
unob-thesis:0.1.0 #3266
Conversation
There was a problem hiding this 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.
There was a problem hiding this comment.
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" |
There was a problem hiding this comment.
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." |
There was a problem hiding this comment.
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" | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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. | |||
There was a problem hiding this comment.
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?
I am submitting
Description: Official thesis template for University of Defence
I have read and followed the submission guidelines and, in particular, I
typst.tomlfile with all required keysREADME.mdwith documentation for my packageLICENSEfile or linked one in myREADME.mdexcluded PDFs or README images, if any, but not the LICENSE