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

guided-resume-starter-cgc:2.0.0 #580

Merged
merged 12 commits into from
May 6, 2024
Merged

Conversation

Spelkington
Copy link
Contributor

@Spelkington Spelkington commented Apr 22, 2024

I am submitting

  • a new package
  • an update for a package

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

After porting a previous template over to Typst, I was sent the recommendation to add it to Typst Universe. The original has now been proofread and typos appropriately swept away — after an additional proofread and local test on my end, this appears to be ready to go!

This is a port of a previous LaTeX package used by undergraduates for creating new resumes. On top of a standard styling, it also includes a set of best practices on how to write good content for a resume, such as:

  • Structuring concise bullet points
  • Formatting non-standard experience as an addition to work experience
  • Methods for tuning resumes to particular job entries

Please let me know if there are any necessary additions needed. Thanks!


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.

@laurmaedje laurmaedje added the new A new package submission. label Apr 29, 2024
}

// Allows hiding or showing full resume dynamically using global variable
#let hide(shouldHide, content) = {
Copy link
Member

Choose a reason for hiding this comment

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

Typst packages generally use kebab-case for naming functions and their arguments. But this is not a hard requirement, and you can decide to leave this as is if you prefer.

Suggested change
#let hide(shouldHide, content) = {
#let hide(should-hide, content) = {

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This should be fixed in 49d62cd!

@@ -0,0 +1,148 @@
#let resume(
Copy link
Member

Choose a reason for hiding this comment

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

Unless you expect people to edit the contents of these functions, I think this file should be outside of the template/ folder (either directly in the root of the package, or in a dedicated sub-folder). As it is done now, this template file would be duplicated in every new project initialized from this template.

Copy link
Contributor Author

@Spelkington Spelkington May 3, 2024

Choose a reason for hiding this comment

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

This project is a bit more "to each their own" than something like IEEE-compliant formatting, so the hope was to include the template file directly to more easily allow users to tweak it to their comfort. However, I'd imagine that Typst is looking to encourage adoption for the packaging system.

As a comfortable compromise, I've:

  • kept the local copy of the template in the repository,
  • switched the #import to the package system copy by default, and
  • provided a brief instruction for users to use the local copy to tweak the editing if they'd like.

I've also added additional comments to the template file itself to make it a bit friendlier to power users who do want to tinker around with the template directly.

Hopefully this is a comfortable in-between!

Copy link
Member

Choose a reason for hiding this comment

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

It is, thank you :)

@Spelkington Spelkington requested a review from elegaanz May 3, 2024 16:39
@elegaanz elegaanz merged commit 60745f7 into typst:main May 6, 2024
1 check passed
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.

3 participants