-
Notifications
You must be signed in to change notification settings - Fork 718
zen-utbm-report:0.1.0 #3159
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?
zen-utbm-report:0.1.0 #3159
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.
Thanks for this package! I've left a few comments regarding the readme, name, and the current file structure.
@@ -0,0 +1,15 @@ | |||
[package] | |||
name = "utbm-report" |
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.
Unless this is an official package, an additional non-descriptive prefix needs to be added to this name. We try to avoid using too canonical names, such that multiple packages for the same purpose can coexist without one having an unfair advantage. See our naming rules
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.
Do I need to change the package name? I've seen others with the name of a university.
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.
If you're a staff member of the university, or get the approval to make this an official package, this name could stay. Otherwise you'll have to change it.
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.
Do I need to make another PR to change the name ?
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.
If you're familiar with git, you can just update this one. Otherwise, if it's easier you can also open a new one.
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.
Everything should be in order now
I am submitting
Minimal Typst template for UTBM coursework reports, with a pre-made cover, automatic semester label (Spring/Autumn) based on date, and a built-in table of contents.
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 keysadded a
README.md
with documentation for my packagehave chosen a license and added a
LICENSE
file or linked one in myREADME.md
tested 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.