From bcbedc29b22538936f702763594679b41a12e810 Mon Sep 17 00:00:00 2001 From: ayuhito Date: Sun, 29 Dec 2024 22:42:51 +0900 Subject: [PATCH] docs: update contributing --- CONTRIBUTING.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2d3aa78b62c..29faa58a486 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,21 +12,23 @@ This repository hosts the font files for the [Fontsource](https://github.com/fon 2. Fork the fontsource/font-files repository (click the Fork button at the top right of this page). 3. Clone the repository locally before creating your own branch. - ```shell - git clone https://github.com/fontsource/font-files.git - git checkout -b my-font-branch main - ``` +**Use `--depth 1` to shallow clone the latest commit as this is an extremely large repository.** -4. Create your font submission using the Fontsource CLI. +```shell +git clone https://github.com/fontsource/font-files.git --depth 1 +git checkout -b my-font-branch main +``` - - Run `pnpm install` in this repository to install the necessary dependencies or install the [Fontsource CLI](https://github.com/fontsource/fontsource) (`@fontsource-utils/cli`) globally with the package manager of your choice. - - Run `npx fontsource create` in the root of this repository and follow the necessary prompts. Ensure your submission matches the [Fontsource Submission Guidelines](#fontsource-submission-guidelines). +1. Create your font submission using the Fontsource CLI. + + - Run `bun install` in this repository to install the necessary dependencies or install the [Fontsource CLI](https://github.com/fontsource/fontsource) (`@fontsource-utils/cli`) globally with the package manager of your choice. + - Run `bunx fontsource create` in the root of this repository and follow the necessary prompts. Ensure your submission matches the [Fontsource Submission Guidelines](#fontsource-submission-guidelines). - Add the font files to the generated directory following the guidelines given in the CLI prompts. - Move the package into the `fonts/other` directory. - - Run `pnpm test` to check if your package has all the required files. + - Run `bun test` to check if your package has all the required files. -5. On GitHub, send a pull request to fontsource/font-files:main. -6. After your pull request is merged, you can safely delete your branch and pull changes from the main repository. +2. On GitHub, send a pull request to fontsource/font-files:main. +3. After your pull request is merged, you can safely delete your branch and pull changes from the main repository. ## Fontsource Submission Guidelines @@ -38,6 +40,5 @@ Fontsource only accepts fonts that have a public official source (preferably Git - Apache License 2.0 (Apache-2.0) - Ubuntu Font License (UFL-1.0) - MIT License -- CC0-1.0 License If you are unsure about the licensing of a font, please contact the font author.