Skip to content

Latest commit

 

History

History
58 lines (33 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

58 lines (33 loc) · 2.85 KB
Raw

Font Library is built with Jekyll and AngularJS, but you don't need to know either to add or edit the tags — you only need to edit a file! First-time contributors welcome here 🎉!

Each font family is stored as an object in families.json. Each family has an array of tags.

image

Help wanted

You can edit families.json to add, edit, or improve tags. I recommend starting by tagging fonts that you often want to find for yourself — curate your own tag! It's likely that someone else will dig your collection.

You can also click Need tags to show all fonts that haven't been tagged yet:

image

Editing families.json guidelines

View families.json

  • Each font should have no more than 5 tags
  • Avoid creating new tags that are similar to already established tags, instead consolidate or rename all similar tags if a different tag name is more intuitive
  • Avoid ambiguous names for tags; make the tag name intuitive (Would you use this tag to find font X?)
  • The family name must match the Google Font family name exactly

These guidelines are enforced by tests. You can run the tests locally by first running npm install from the command line and then npm test. Alternatively, you can wait to create a pull request and the tests will run there.

Contributing

There are a few different ways to contribute, you can:

  1. Edit from Github.com directly
  2. Create a pull request
  3. Create an issue

1. Edit from Github.com directly

Open up families.json to start editing.

❔ If you're new to Github, I recommend reading: Editing files in another user's repository. (And don't worry, you won't break anything!)

2. Create a pull request

You can create a pull request to edit tags or to add newly added Google fonts.

When creating a pull request, it's helpful to:

  • Double check your tags and ask yourself if it's something that you would use to find fonts
  • Provide a brief description of the tags you added or changed
  • Edit tags in small batches (<20 edits) to help speed up the reviewing process

❔ If you're new to Github, I recommend reading: Creating a pull request.

3. Create an issue

You can also create an issue to recommend changes to the library.

❔ If you're new to Github, I recommend reading: Creating an issue

💜 Happy tagging! 💜