From 1cf9aad2badcfc74ac8d72c916ccdee2fc600ca4 Mon Sep 17 00:00:00 2001 From: Rosalie Wagner Date: Thu, 16 Jun 2022 18:42:05 +0200 Subject: [PATCH] Update CONTRIBUTING.md (#4787) * Update CONTRIBUTING.md References to GF Guide * Update CONTRIBUTING.md --- CONTRIBUTING.md | 30 +++++------------------------- 1 file changed, 5 insertions(+), 25 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1129990006..70abd17b95 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,7 @@ # Contribute to Google Fonts +There is a detailed documentation online aiming to help people contributing to Google Fonts. Please refer to the [Google Fonts Guide](https://googlefonts.github.io/gf-guide/) before contributing to this repository. + ## Feedback If you have any feedback on Google Fonts API, directory, or the fonts themselves, please create an issue at [github.com/google/fonts/issues](http://github.com/google/fonts/issues). Don't forget to search in the issue tracker (using keywords) if your issue has already been raised before opening a new one :) @@ -9,27 +11,11 @@ If you have any feedback on Google Fonts API, directory, or the fonts themselves - [Report a problem with a font](https://github.com/google/fonts/issues/new?assignees=&labels=II+Font+Bug&template=3_font-bug.md&title=) - [Anything else](https://github.com/google/fonts/issues/new?assignees=&labels=II+API+%2F+Website+%2F+Platform%2C+II+Tools+%2F+workflow+%2F+repo&template=4_anything-else.md&title=) -## New Families - -If you would like to include a new font family in the Google Fonts collection, we'll be happy to include it if it meets the following criteria: - -* The typeface design must be original, or a legitimate revival of a design in the public domain, and of good quality. The Google Design team curates the overall Google Fonts collection and decides if fonts are of good quality. We may reject families if they fail to meet our criteria. You can get general reviews of your project from the wider international type community during development by posting review requests in the [googlefonts-discuss](https://groups.google.com/forum/#!forum/googlefonts-discuss) group, and the [typedrawers](http://typedrawers.com/categories/critiques%E2%80%94type-design) review forum. -* The project must be **wholly** licensed under the [SIL Open Font License v1.1](http://scripts.sil.org/OFL), and there are no proprietary/restricted-license versions of the project available elsewhere (such as additional weights/styles.) -* The Open Font License should not have any Reserved Font Names ([why](https://github.com/simoncozens/silson/issues/1)) -* The copyright holders must all have filled in the [Google Contributor's License Agreement](https://cla.developers.google.com) forms. -* The font family name should not include any copyright holder full names (but first names are OK), no registered trademarks, and no initials or abbreviations, and no references to languages or writing systems; it should be a simple and unique name. A limited but easy way to test for uniqueness is [namecheck.fontdata.com](https://namecheck.fontdata.com) -* The project must be developed on Github or similar, with complete corresponding sources, [open to public participation](http://producingoss.com), and actively maintained. Complete corresponding sources means that the fonts are available in your preferred form of modification, the files you actually use to develop the project, along with all the build instructions or scripts needed to reproduce the process of turning those source files into your released font binaries. -* All binary font files must be available in TTF format, and should have hinting (such as with [ttfautohint](http://www.freetype.org/ttfautohint/)). -* All font files must be built with a scripted build process, and should use [fontmake](https://github.com/googlefonts/fontmake) -* All font files should support at least "GF Latin Core" glyph set. (Learn more about the Google Fonts glyph sets in the [googlefonts/glyphsets](https://github.com/googlefonts/glyphsets/tree/main/GF_glyphsets) repository.) -* All font files within the family must have the same Unicode character set (unencoded glyphs can differ) and corresponding upper/lower case pairs -* All font files should pass the [Font Bakery](https://github.com/googlefonts/fontbakery) checks for the [`googlefonts` profile](https://font-bakery.readthedocs.io/en/stable/fontbakery/profiles/googlefonts.html). -* A `README.md` file must be included in the root of the source repository, and inside of that file we can read about the project with the kind of information suggested by SIL in their [FONTLOG](http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=ofl-faq_web#43cecb44) recommendation (but no FONTLOG file itself is needed). Get inspired by our repo template: https://github.com/googlefonts/googlefonts-project-template, or by an existing repository: https://github.com/Omnibus-Type/Texturina. +## Adding and Upgrading families -**More detailed design and production details are listed in our [Project Specification](https://github.com/googlefonts/gf-docs/tree/main/Spec)** +The online documentation dedicates a chapter to [requirements for font submission and upgrade suggestion](https://googlefonts.github.io/gf-guide/onboarding.html). Please read it carefully. -If you are able to meet these requirements yourself, please [create a new issue](https://github.com/google/fonts/issues) with a link to the project's source repository. -In special circumstances, you can request an exception to these requirements on your issue. +If you are able to meet these requirements yourself, please [create a new issue](https://github.com/google/fonts/issues) with a link to the project's source repository. In special circumstances, you can request an exception to these requirements on your issue. If you are a non-technical person who has developed a high quality typeface in a GUI application and are happy to meet all these requirements in spirit but need someone else to take care of all the technical stuff, Google Fonts also accepts submissions via email. Send an email to fonts@google.com with an attachment that includes complete source files, along with a clear statement you are the sole original author and are licensing the source files under OFL, with a request that we take care of everything else. @@ -37,12 +23,6 @@ Send an email to fonts@google.com with an attachment that includes complete sour From time to time, Google Fonts provides financial and design assistance for projects. If you would like to discuss this, please mention that you would like someone to contact you privately when filing an issue (and have contact details on your Github profile page.) -### Updates - -If your font is already on-boarded and you'd like us to update our copy, please file an issue (instead of making a pull request directly.) - -We carefully check the technical aspects of updated fonts to prevent unintended changes, so we prefer to collaborate with you on your upstream project to make a release which we update from. - ## Contributor License Agreement We love to accept all good patches and contributions to this project. -- 2.47.3