Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add contribution documentation #191

Open
GilOliveira opened this issue Nov 1, 2022 · 2 comments
Open

Add contribution documentation #191

GilOliveira opened this issue Nov 1, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@GilOliveira
Copy link

GilOliveira commented Nov 1, 2022

A frequent issue delaying the addition of new icons is the lack of documentation on how to contribute the font files to the source tree from an SVG version of the logos (see #174 (comment), #184 (comment)).

A simple document explaining the steps to generate the font files (such as a CONTRIBUTING file) would streamline the addition of new icons by educating contributors on how to generate the files needed so that they can submit the PR themselves, thus making the process of adding new icons faster, and also allowing the repo maintainers to save the time they would've spent doing it themselves.

@nfrerebeau
Copy link
Collaborator

I will try to add a guide to describe the main steps. The main difficulty is the availability of a workable logo, provided by the organization (e.g. #174, I had to contact the arXiv team to ask if they have a monochrome logo as I can't modify it myself).

@nfrerebeau nfrerebeau added the documentation Improvements or additions to documentation label Nov 5, 2022
@GilOliveira
Copy link
Author

I will try to add a guide to describe the main steps.

Thank you so much!

The main difficulty is the availability of a workable logo, provided by the organization.

I can tell, but for folks who either already have a workable version of the logo, or are able to do it themselves, I recon it will save you a lot of effort if people were able to submit the PR themselves, rather than submitting the SVG and you having to do the whole font regenerating yourself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants