cyberschool-errorteaplate:0.1.3 #1742
Conversation
| @@ -0,0 +1,28 @@ | |||
| [package] | |||
| name = "cyberschool-template" | |||
There was a problem hiding this comment.
Unless this is an official package, I will ask you to change the name. It should be unique enough for another alternative implementation to co-exist without giving your package an advantage. The most common strategy is to add a distinctive adjective to the institution name.
If the package is officially endorsed by the school staff, a representative should send an email to hello@typst.app stating so.
Also, I would remove the template suffix, it feels redundant. It should be clear enough that this is a template with the context.
There was a problem hiding this comment.
I have updated the name on this commit
| name = "cyberschool-template" | ||
| version = "0.1.3" | ||
| entrypoint = "src/lib.typ" | ||
| authors = ["ErrorTeaPot contact.233s7@simplelogin.com"] |
There was a problem hiding this comment.
Your email address should be between chevrons. Also, if you are using a SimpleLogin address to avoid spam, know that you are not forced to give an email address, you can just have your username here.
There was a problem hiding this comment.
I have removed the email address on this commit
|
Since I have changed the package name what is the process regarding the directory name in |
|
Yes, you should rename the directory too. |
typst-package-check
bot
changed the title
|
The second CI check (@preview/cyberschool-errorteaplate) checks if the package is into the repos. Since it is my first upload (at all and of this package) what should I do ? |
|
The CI is able to resolve the package from the template, the issue here is that you are using the wrong namespace: it should be |
|
The package is now passing the CI tests, do I have other things to change ? |
|
It would be nice if you could update your README file to have something else than a placeholder. It doesn't have to be very long, but it should explain what that package is, and optionally how to use it and show what it looks like. Same goes for the changelog, you should either fill it or remove it if you don't plan to actually use it. |
|
I have updated it, is it fine as it is ? |
|
@elegaanz Any news ? |
I am submitting
This is a template based on my school colors and logos. It can be useful at first for the people in my school since it will be ready to use, but I have made it modular enough to change logos, titles,...
The version is not 0.1.0 but 0.1.3 because I have changed basic things but my CI requires new version numbers.
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.