Skip to content
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

isec-master-thesis-template:1.0.0 #1548

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
Open

Conversation

ecomaikgolf
Copy link

@ecomaikgolf ecomaikgolf commented Jan 10, 2025

I am submitting

  • a new package
  • an update for a package

Description: Its the Master Thesis template for the ISEC (Institute of Information Security) from the Graz University of Technology (TUGraz). Has not been officially checked for compliance (stated in the README). Its useful for students wanting to complete their master studies.

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.

Extra Notes:

I needed acronyms and notation (similar to acronyms) support with some features. I pulled acrostiche into packages/ from the template and applied my patches.

It's not the cleanest solution to package a downstream copy of acrostiche locally but I needed the patches for the template.

I'm not completely sure if this is allowed for upstreaming the template :)

Edit:

This is my first submission to Typst Universe

@typst-package-check typst-package-check bot added the new A new package submission. label Jan 10, 2025
@ecomaikgolf
Copy link
Author

CI checks hang when I mistakenly used @local/ in template/thesis.typ

@ecomaikgolf
Copy link
Author

. Package names should be short and use the official entity abbreviation. Template authors are encouraged to add the full name of the affiliated entity as a keyword.

I'm not sure if this would be considered short. I would welcome input in this.

@elegaanz
Copy link
Member

Regarding the name, first of all, because this is not an official package it should be less "canonical". You can just add a distinctive adjective or noun to the current name, try to make a pun, or anything else that will make the name more unique. I would also remove the word "template" as it is a bit redundant in my opinion.
Other than that, your package looks good. I'll you change the name for something else, and then it should be good to merge.
Thanks for the submission.

@ecomaikgolf
Copy link
Author

Regarding the name, first of all, because this is not an official package it should be less "canonical".

Would isec-master-thesis be okay if this package gets support/endorsement directly by the institute (ISEC)? I could ask a professor for permission.

I would also remove the word "template" as it is a bit redundant in my opinion.

Totally agree, will do.

Other than that, your package looks good. I'll you change the name for something else, and then it should be good to merge. Thanks for the submission.

Thanks for the valuable input :)

@elegaanz
Copy link
Member

Yes this name would be suitable. The institute staff should send an email to [email protected] to state that they officially endorse this package.

@ecomaikgolf
Copy link
Author

Perfect. I contacted the institute for permission. I will wait for it and rename it either to isec-master-thesis or something not official.

In a different matter, these two checks from the pull request started 3 days ago and are still unfinished:

This happens when you use @local/ in the barebone template document (template/thesis.typ in this case) instead of @preview/

@elegaanz elegaanz added the waiting-on-author Pull request waits on author label Jan 14, 2025
@elegaanz
Copy link
Member

Yes, CI is a bit fragile, and it will sometimes crash if it runs out of disk space. I should just move it to a server with a larger disk, but it is not alarming that these checks keep running.

@typst-package-check typst-package-check bot removed the waiting-on-author Pull request waits on author label Jan 22, 2025
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