Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

32 lines (23 loc) · 1.73 KB

Contributing Icons

It is recommended to use the free and open source Inkscape vector editor to create elementary icons. Any and all icons must follow the elementary Icon Design Guidelines.

An elementary color palette is provided, it is recommended to copy it into your Inkscape settings before you get started.

(Run these from the root of the icons repo)

cp data/elementary.gpl ~/.config/inkscape/palettes/

For flatpak installations, use one of the following.

# Local
cp data/elementary.gpl ~/.local/share/flatpak/app/org.inkscape.Inkscape/current/active/files/share/inkscape/palettes/

To contribute to the elementary icon set, open a pull request to this repository with your icon(s).

It is strongly encouraged to vacuum all vectors with Inkscape. This keeps the repository lean, clean, and fast for everyone. For convenience, a git pre-commit hook is included. To install, run these commands from your local repository folder:

$ cp pre-commit .git/hooks/
$ chmod +x .git/hooks/pre-commit

Not a Universal Icon Set

Since this set is designed specifically for elementary OS, pull requests to add icons or symlinks that are specific to other desktop environments (such as xfce-* or gnome-* named icons) will be rejected.

Use of icon names in line with the FreeDesktop.Org Icon Naming Specification is encouraged.

Third-Party Brand Preservation

elementary icons do not attempt to supply icons for third-party apps. Pull requests to add icons or symbolic links that would overwrite the branding of third-party apps will be rejected.