Contributor Setup

These instructions hlep you improve Fontknife by writing code or documentation This includes:

  1. Fixing bugs and typos

  2. Adding new features and information

  3. Testing or reviewing any of the above

If you need to…

…you may want to see:

Convert font data in the terminal

User Install

import fontknife in Python code

Library Install

Requirements

Basic Pre-Reqs

First, make sure you have the following:

  1. Python 3.10+ installed

  2. A GitHub account

Making Sure to Fork & Clone the Repo

Now you need to make your own copes of the repo to work from.

First, make sure you’re logged into GitHub. Then:

  1. Create a copy of the Fontknife repo on GitHub by forking it into your account

  2. Get your fork’s code onto your computer by cloning your fork

Editable Install

After you’ve forked and cloned the repo, you’ll want to make set up your local environment.

Note that Fontknife does not currently use a tool which heavily automates the development environment (Poetry, etc). This means you may have to take a more hands-on approach than you’re used to.

Otherwise, the steps will be the same as for most projects:

  1. Open a terminal window

  2. cd fontknife to enter the directory

  3. Create a virtual environment

  4. Activate the virtual environment

  5. Run pip install fontknife -e .[dev,docs] to install the project and its dependencies in editable mode.

Once you’re done, remember to take a break. Once you’re ready, you’ll want to try Testing the Code & Building Docs.