Skip to content

Commit

Permalink
docs: update contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
ayuhito committed Dec 29, 2024
1 parent afba329 commit bcbedc2
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <kbd>Fork</kbd> 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

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

0 comments on commit bcbedc2

Please sign in to comment.