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

athena-tu-darmstadt-thesis:0.1.0 #639

Merged
merged 7 commits into from May 22, 2024

Conversation

JeyRunner
Copy link
Contributor

I am submitting

  • a new package
  • an update for a package

Description: This is an unofficial thesis template for the University TU Darmstadt (Technische Universität Darmstadt) following the university design guidelines while imitating the existing official latex template.

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.

Copy link
Contributor

@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.

Hello and thanks for your submission :) I left a few remarks, but it looks good overall.

repository = "https://github.com/JeyRunner/tuda-typst-templates"
keywords = ["TU Darmstadt", "Technische Universität Darmstadt", "Bachelorthesis", "Masterthesis", "Bachelorarbeit", "Masterarbeit", "thesis"]
categories = ["thesis"]
exclude = ["tests", "example_tudapub.pdf"]
Copy link
Contributor

Choose a reason for hiding this comment

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

I think example_tudapub.typ could be excluded too, as it not really useful to have an example file in the archive that the compiler downloads when installing the package.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, you are right.
Btw, is the point excluded PDFs or README images, if any, but not the LICENSE meant as in just add all excluded files to exclude in the typst.toml or also not include these files in this repo?

Copy link
Member

Choose a reason for hiding this comment

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

The former, although you are free to choose which excluded files you deem important enough to the package to include them in your PR.

// This function gets your whole document as its `body` and formats it.
#let tudapub(
title: [Title],
title_german: [Title German],
Copy link
Contributor

Choose a reason for hiding this comment

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

Even if not mandatory, it is recommended to use kebab-case names (at least for user facing functions and their arguments). If you prefer to keep snake_case everywhere, it is also possible to merge it as is.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes. I am planning to change this in a future version.
But for the first version, I want to keep the names as-is, since I and at least one other person use the package locally with the current snake_case. I want to ensure that the local versions can be replaced with the universe version without breaking anything.

@@ -0,0 +1,8 @@
#!/bin/sh
Copy link
Contributor

Choose a reason for hiding this comment

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

Same remark for this file (and more generally the whole logos directory)

@reknih reknih force-pushed the main branch 6 times, most recently from 92aab43 to d06d87c Compare May 15, 2024 10:12
@JeyRunner
Copy link
Contributor Author

Thanks for the feedback, I removed the redundant files and excluded the additional example file.

@reknih reknih merged commit 304eb90 into typst:main May 22, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants