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

ustc-proposal:0.0.1 #1710

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

ustc-proposal:0.0.1 #1710

wants to merge 1 commit into from

Conversation

Freed-Wu
Copy link

@Freed-Wu Freed-Wu commented Feb 13, 2025

I am submitting

  • a new package
  • an update for a package

Description: Explain what the package does and why it's useful.

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.

@typst-package-check typst-package-check bot added the new A new package submission. label Feb 13, 2025
@Freed-Wu Freed-Wu force-pushed the ustc-proposal branch 7 times, most recently from 7fbfaf8 to 6df28eb Compare February 14, 2025 08:19
Copy link
Member

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

Your template contains too many files that are not directly related to the project in my opinion. I understand that these files may be useful for power users, but I think for someone who doesn't use all these tools they will just feel like too much (especially in the web app where you can't really use any of that). Since I can see that you are using Nix, I would recommend using the flake template features to provide a "full" template (or alternatively the GitHub "repository template" feature), and to keep the Typst template as minimal as possible.

Also, I'm not sure what the purpose of the package is, but the name may too descriptive/generic. Please make sure to conform to the naming guidelines.

@typst-package-check typst-package-check bot changed the title ustc-proposal:0.0.1 diagraph:0.3.1 and ustc-proposal:0.0.1 Feb 14, 2025
@typst-package-check typst-package-check bot added the update A package update. label Feb 14, 2025
@typst-package-check
Copy link

@Robotechnic You released diagraph:0.3.0, so you probably want to have a look at this pull request. If you want this update to be merged, please leave a comment stating so. Without your permission, the pull request will not be merged.

@typst-package-check typst-package-check bot changed the title diagraph:0.3.1 and ustc-proposal:0.0.1 ustc-proposal:0.0.1 Feb 14, 2025
@typst-package-check typst-package-check bot removed the update A package update. label Feb 14, 2025
@Freed-Wu Freed-Wu force-pushed the ustc-proposal branch 2 times, most recently from 6645057 to b85e802 Compare February 18, 2025 05:43
@elegaanz
Copy link
Member

Hello. With regards to the package name, I would like to know if this is intended to be an official template or not?

Also, the compiler reports an issue when building your template, can you please fix it?

@Freed-Wu
Copy link
Author

it waits typst 0.13.0

Offical docx template doesn't have English name.

@elegaanz
Copy link
Member

Sorry to ask for changes again, but can you fix the deprecation warnings too?

Regarding the name, I was more asking whether this package is considered official too, not what the name of the official Word template is. But I assume it is not then. Can you please rename the package to something more distinctive?

@Freed-Wu Freed-Wu force-pushed the ustc-proposal branch 2 times, most recently from 1276693 to f85bbb6 Compare April 1, 2025 11:41
@Freed-Wu
Copy link
Author

Freed-Wu commented Apr 1, 2025

fix the deprecation warnings too?

Fixed.

Can you please rename the package to something more distinctive?

Any suggestion?

@elegaanz
Copy link
Member

elegaanz commented Apr 1, 2025

The easiest way to make your package name more unique is to add another word as a prefix. Here are some example from other packages, feel free to pick one from that list or to look up a more complete list of adjectives online.

A long list of adjectives found in other package names
abiding
academic
accelerated
adaptable
appreciated
basic
big
blind
bloated
brilliant
casual
charged
chic
classic
classy
clean
clear
colorful
dashing
dashy
divine
easy
fancy
friendly
fuzzy
gentle
graceful
great
grotesk
guided
handy
hidden
iconic
lacy
light
lucky
minimal
minimalistic
nifty
optimal
orange
pioneering
pointless
quick
rich
silky
silver
simple
sleek
smooth
splendid
stellar
structured
sunny
superb
supercharged
super
sweet
tasteful
unequivocal
universal
versatile
zen

Generally, feel free to take inspiration from other package names.

You can also make a reference to a fun fact about the university, or a pun with its name.

Another option if you don't like any of the previous proposals would be to simply add your username as a prefix or suffix to the current name.

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