uwa-thesis:0.1.0 - #5501
Conversation
elegaanz
left a comment
elegaanz
left a comment
There was a problem hiding this comment.
Thank you for submitting this package. There are issues regarding its structure and metadata that needs to be fixed, can you take a look please?
| ) | ||
| ``` | ||
|
|
||
| Place image assets (e.g. `img.jpeg`) in the [assets/](assets/) folder and reference them with a path like `"assets/img.jpeg"`. |
There was a problem hiding this comment.
It is a bit misleading: the assets folder won't exist in the user project, and generally speaking it is not mandatory to put images in a specific folder.
| categories = ["thesis", "report", "university", "uwa"] | ||
|
|
||
| [template] | ||
| path = "template" |
There was a problem hiding this comment.
This directory is missing. You should create it and move main.typ inside. The template also needs a thumbnail to be valid.
| entrypoint = "template.typ" | ||
| license = "MIT" | ||
| description = "A thesis template for UWA School of Engineering Thesis" | ||
| categories = ["thesis", "report", "university", "uwa"] |
There was a problem hiding this comment.
You can have at most three categories, and they should be among the allowed ones. You can use the keywords field if you need more.
| @@ -0,0 +1,12 @@ | |||
| [package] | |||
| name = "uwa-thesis" | |||
There was a problem hiding this comment.
The name is still too descriptive and more importantly it can be considered to be the canonical name for that package: that's what you would expect the official package for this university to be called. Can you please pick another name? In general, adding a unique prefix or suffix to an otherwise canonical name is enough to fit our guidelines.
There was a problem hiding this comment.
Unless you took this image yourself and decide to share it under the same terms as the rest of your package, can you please specify the relevant copyright and/or licensing information (for example at the end of your README).
3 participants
I am submitting
A package for The University of Western Australia Engineering Students doing their final year thesis
Description: Thesis template based on GENG4412/5512 template from course materials.
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.tomlfile with all required keysadded a
README.mdwith documentation for my packagehave chosen a license and added a
LICENSEfile or linked one in myREADME.mdtested my package locally on my system and it worked
excluded PDFs or README images, if any, but not the LICENSEensured 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.