ryanoasis / nerd-fonts

Iconic font aggregator, collection, & patcher. 3,600+ icons, 50+ patched fonts: Hack, Source Code Pro, more. Glyph collections: Font Awesome, Material Design Icons, Octicons, & more
https://NerdFonts.com
Other
52.6k stars 3.59k forks source link

Instructions for adding a new font slightly confusing #1655

Closed kaBeech closed 2 weeks ago

kaBeech commented 2 weeks ago

🗹 Requirements

🎯 Subject of the issue

Documentation for adding new fonts in contributing.md

Experienced behavior:

When reading the "Steps for adding a new font..." section in contributing.md, Step 4 seemed to me to be saying to commit the newly patched font files (in reality the instructions are only to commit changes to config.cfg)

Maybe this is just my brain being weird, if so feel free to close this issue =)

On the other hand, if it's helpful I have this commit that clarifies the documentation and I'd be happy to open a PR for it if you like =)

Expected behavior:

The instructions in the "Steps for adding a new font..." section in contributing.md, Step 4 clearly advises to commit only changes to config.cfg and to not commit the newly patched font files

Example symbols:

N/A

🔧 Your Setup

★ Screenshots (Optional)

contributing

Thanks!

Finii commented 2 weeks ago

Thanks! Please check if the new wording is better :-D

kaBeech commented 1 week ago

Looks good - thanks @Finii!