Skip to content

academic-uiu-fydp:0.1.0 - #6418

Open
shaadahmmed wants to merge 1 commit into
typst:mainfrom
shaadahmmed:add-academic-uiu-fydp-0.1.0
Open

shaadahmmed wants to merge 1 commit into
typst:mainfrom
shaadahmmed:add-academic-uiu-fydp-0.1.0

Conversation

@shaadahmmed

Copy link
Copy Markdown

I am submitting

  • a new package
  • an update for a package

Description: A community template for Computer Science and Engineering final year design project reports at United International University, Dhaka. It provides FYDP-1 and final-report variants, configurable title/front matter, multiple students and supervisors, separate editable chapters, engineering mapping tables, automatic contents and figure/table lists, and numeric references. Student and educator guides are included. No university logo is distributed and no institutional endorsement is claimed.

Source: https://github.com/shaadahmmed/uiu-fydp-template (release preparation: e394c52).

Shaad Ahmmed adapted Swakkhar Shatabda's original Overleaf template. The original is listed under CC BY 4.0; that license and attribution are retained in LICENSE, NOTICE, the README, and the starter notice.

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
    • Explanation: academic-uiu-fydp uses a distinguishing qualifier rather than claiming the bare uiu or fydp name. UIU identifies the intended university and FYDP identifies its final year design project reports. This is a community adaptation, not an official university package; naming feedback is welcome.
  • 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.

Licensing review requested for the last item: the adaptation retains the inherited CC BY 4.0 terms, including attribution, rather than claiming permission to waive the original author's rights. The starter prompts are intended to be replaced during normal writing, and the documentation explains that users' original prose, research, results, and data are their own work. I have left this item unchecked so the inherited license's compatibility with the special template requirement can be reviewed explicitly.

Validation performed:

  • The complete local integration suite passes with the official Typst 0.15.0 compiler: local final/FYDP-1 reports, freshly initialized package final/FYDP-1 reports, optional publications and front matter, multiple students/supervisors, the minimal API, and both README examples.
  • Package documentation links and version consistency are checked; there are no third-party Typst dependencies or external font requirements.
  • The PNG thumbnail is generated from the freshly initialized logo-free starter and meets the documented dimensions and size requirements.
  • The official ghcr.io/typst/package-check:0.7.0 checker successfully compiles the starter and verifies the public source URL after correcting an exclusion that blocked main.typ.
  • The only remaining diagnostic from that checker is manifest/package/license/osi for CC-BY-4.0. The package licensing guide explicitly allows CC-BY licenses, while the v0.7.0 checker's src/check/manifest.rs rejects every SPDX license that is not OSI-approved. Please review this discrepancy alongside the inherited starter license.

@shaadahmmed
shaadahmmed deployed to Package Check November 15, 2026 19:22 — with GitHub Actions Active
@typst-package-check typst-package-check Bot added the new A new package submission. label Nov 15, 2026

This branch was successfully deployed

1 active deployment
Package Check — 5436f1d3 Deployed Nov 15, 2026 by shaadahmmed via Lint #7396
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.

1 participant