Skip to content

Latest commit

 

History

History
28 lines (17 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

28 lines (17 loc) · 1.29 KB
Raw

Contributing to the package or template

You can simply fork this repo and work on it on your own. Feel free to PR if this repo is still active !

If you plan to distribute your version of the package, please make sure you pay respect to both Typst packages guidelines and École polytechnique corporate identity.

Pushing to Typst packages

Check out Typst packages repo to learn more about packages release pipeline.

I personally suggest the following steps :

  • fork the Typst packages repo

  • in the root directory, for every x.y.z version (if the main branch currently contains the x.y.z release) :

    git subtree add --prefix=packages/preview/typographix-polytechnique-reports/x.y.z [email protected]:remigerme/typst-polytechnique.git main

    You may need to pull sometimes (if the release wasn't fully ready) :

    git subtree pull --prefix=packages/preview/typographix-polytechnique-reports/x.y.z [email protected]:remigerme/typst-polytechnique.git main

  • PR your fork to publish the package.

You do not need to squash the commit history at anytime because Typst packages will do it on merge.