Skip to content

Latest commit

 

History

History
15 lines (11 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

15 lines (11 loc) · 1.33 KB

Contributing to Monocraft

Contributions to the font are always welcome, though please be sure to adhere to these guidelines if you want your changes to be approved.

Guiding Principles of Monocraft

  • Characters must look exactly the same as they do in Minecraft
    • The only exception is if the character is too wide to fit in the font and still be monospaced. In this case, we would modify the glyph to fit if possible. Such modifications will likely need to be run by @IdreesInc first to ensure that the style is kept consistent with other glyphs
  • Ligatures must always be helpful and never annoying
    • This means that ligatures that might work in one context (like <= as an arrow) but fail in another (like when <= should instead be "less than or equal to") should not be added to Monocraft
    • As a rule, it's usually better to only add ligatures that someone might expect rather than every possible ligature so as to avoid ligatures appearing out of place
  • The code that generates Monocraft should be clean, consistent, and maintainable
    • If you feel as if a feature would be hard to add cleanly, contact @IdreesInc instead and I'll see if we can work something out

So long as you keep in line with the above principles, your PR is much more likely to be merged. Good luck!