Difference between revisions of "Guidelines and HOWTOs/Submit an icon"

m (→‎Tips and tricks: Add link to Icon Workflow Tips page)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
= Get the Breeze Icons git repository =
 
= Get the Breeze Icons git repository =
If you already have a KDE development environment set up using the <code>kdesrc-build</code> tool (see https://community.kde.org/Get_Involved/development#One-time_setup:_your_development_environment), then you can get breeze-icons by doing the following:
+
First you will need to download the breeze-icons source code repository, build it, create a personal fork of it, and set up your personal fork as a new "remote" in your local download of the git repository. Instructions for doing that can be found here: https://community.kde.org/Infrastructure/GitLab
{{Input|1=<nowiki>
 
kdesrc-build breeze-icons
 
</nowiki>}}
 
  
If not, and you aren't interested in setting one up right now, here's how to proceed anyway:
 
  
First you need to get the <code>git</code> command line tool, which allows you to interact with reoisitories of source code (and icons!). Open a terminal program such as Konsole, which is shipped by default in most KDE Linux distributions. In the terminal window, type one of the following commands (depending on which Linux distribution you're using) and then press the enter or return key:
+
= Start working =
 
+
As part of the previous step, you should have a git repository named "breeze-icons" at <tt>[your home folder]/kde/src/breeze-icons/</tt>. You can now get on with editing an existing icon or submitting a new one. Explore the folder structure inside <tt>[your home folder]/kde/src/breeze-icons/</tt> a bit to get a feel for the structure of the repository--where things live, what kinds of icons go where, and so on. The [https://hig.kde.org/style/icons/index.html Breeze Icon design guidelines] offer more information, and helpful guidelines regarding the style you should match.
* Arch/Antergos/Manjaro: <code>sudo pacman -S git</code>
 
* Fedora: <code>sudo dnf install git</code>
 
* KDE Neon/Kubuntu/Ubuntu/Debian: <code>sudo apt install git</code>
 
* openSUSE Leap & Tumbleweed: <code>sudo zypper install git</code>
 
<br />
 
Now for each line below, type the commands and press the enter or return key:
 
{{Input|1=<nowiki>
 
mkdir -p ~/kde/src/
 
cd ~/kde/src/
 
git clone git://anongit.kde.org/breeze-icons.git
 
</nowiki>}}
 
 
 
You have just "cloned" the Breeze Icons git repository to <tt>[your home folder]/kde/src/breeze-icons/</tt>, which is where it now lives. You can now get on with editing an existing icon or submitting a new one. Explore the folder structure inside <tt>[your home folder]/kde/src/breeze-icons/</tt> a bit to get a feel for the structure of the repository--where things live, what kinds of icons go where, and so on. The [https://hig.kde.org/style/icon.html Breeze Icon design guidelines] offer more information, and offer helpful guidelines regarding the style you should match. Always follow the [https://hig.kde.org/style/icon.html Breeze Icon design guidelines]!
 
  
 
KDE icons are SVG files. We recommend the use of Inkscape or another free, open-source vector graphics editor for maximum compatibility.
 
KDE icons are SVG files. We recommend the use of Inkscape or another free, open-source vector graphics editor for maximum compatibility.
 
  
 
= How to edit an existing icon =
 
= How to edit an existing icon =
Line 32: Line 14:
 
= How to create a new icon =
 
= How to create a new icon =
 
To submit a new icon, first create it in your vector graphics editor, and then once you're done, save it to the appropriate place in the <tt>breeze-icons</tt> repository. For example if you are submitting a new app icon, you would save it inside <tt>[your home folder]/kde/src/breeze-icons/icons/apps/48/</tt>. If you are submitting an icon of a type that comes in multiple sizes (for example, an action icon), be sure to save each version to the correct location.
 
To submit a new icon, first create it in your vector graphics editor, and then once you're done, save it to the appropriate place in the <tt>breeze-icons</tt> repository. For example if you are submitting a new app icon, you would save it inside <tt>[your home folder]/kde/src/breeze-icons/icons/apps/48/</tt>. If you are submitting an icon of a type that comes in multiple sizes (for example, an action icon), be sure to save each version to the correct location.
 +
 +
 +
= Post-processing steps =
 +
After using Inkscape to edit an icon or create a new icon, you will want to do two things before you submit your work for review
 +
# Run an SVG optimizer on it. To learn how to do this, see https://community.kde.org/Guidelines_and_HOWTOs/Icon_Workflow_Tips#SVG_optimization
 +
# If it is a monochrome icon, fix the internal stylesheets, which inkscape has mangled. TO learn how to do this, see https://community.kde.org/Guidelines_and_HOWTOs/Icon_Workflow_Tips#Embedding_stylesheets_in_SVGs
  
  
 
= Submit your proposal for review =
 
= Submit your proposal for review =
 
+
Once you have edited some icons and/or saved your proposed new icons to the appropriate places,  it's time to submit a merge request so that the KDE VDG team can review it. Type the following commands in your terminal window, pressing the enter or return key after each line, as before:
Once you have edited some icons and/or saved your proposed new icons to the appropriate places,  it's time to submit a patch so that the KDE VDG team can review it. Type the following commands in your terminal window, pressing the enter or return key after each line, as before:
 
 
{{Input|1=<nowiki>
 
{{Input|1=<nowiki>
 
cd ~/kde/src/breeze-icons/
 
cd ~/kde/src/breeze-icons/
 +
git checkout -b some-name-of-your-choosing-for-this-git-branch
 
git add .
 
git add .
git diff --staged > ~/Desktop/icons.patch
+
git commit
 +
[now enter a good commit message]
 +
git push fork
 
</nowiki>}}
 
</nowiki>}}
  
You now have a "patch file" called <tt>icons.patch</tt> sitting on your desktop. You can now submit this file using Phabricator; see https://community.kde.org/Infrastructure/Phabricator#Posting_a_Patch_using_the_website
+
After you push the new commit to your fork using the last command, the terminal window will display a link you can visit to create a Merge Request. You can control-click on that link to open it directly in your web browser.
  
Add <tt>#vdg</tt>as the reviewer. Once you've submitted the patch, please post a comment mentioning your full name and email address.
+
To finalize submitting your merge request, see https://community.kde.org/Infrastructure/GitLab#Create_the_Merge_Request
  
  
 
= What happens next =
 
= What happens next =
Members of the KDE VDG team will review your patch and propose improvements. This is a conversation that you can and should participate in! If changes are requested, you should make those changes, and re-run the commands that spat out a patch file to generate a new one. Re-submit that new patch file, and keep going until your reviewers are happy. At that point the patch will be landed and you'll officially be a KDE contributor!
+
Members of the KDE VDG team will review your patch and propose improvements. This is a conversation that you can and should participate in! If changes are requested, you should make those changes in your local breeze-icons git repo and push them to your fork. To learn how to do this, see https://community.kde.org/Infrastructure/GitLab#What_happens_next.3F.
 +
 
 +
Keep going until your reviewers are happy. At that point the merge request will be merged and you'll officially be a KDE contributor!
  
  
 
= Tips and tricks =
 
= Tips and tricks =
This whole business of generating patch files gets tedious after a while, doesn't it? Instead, consider setting up the <code>arc</code> command-line tool, which makes it much easier to submit patches. To do that, see https://community.kde.org/Infrastructure/Phabricator#Using_Arcanist_to_post_patches
+
Also, it's helpful if you go through the full development environment setup (https://community.kde.org/Get_Involved/development#One-time_setup:_your_development_environment) This will allow you to compile the tests in the Breeze Icons repo and then run them:
 
 
Also, it's helpful if you go through the full development environment setup (https://community.kde.org/Get_Involved/development#One-time_setup:_your_development_environment) This will allow you compile the tests in the Breeze Icons repo and then run them:
 
 
{{Input|1=<nowiki>
 
{{Input|1=<nowiki>
 
kdesrc-build breeze-icons
 
kdesrc-build breeze-icons
Line 62: Line 52:
 
</nowiki>}}
 
</nowiki>}}
  
Icon workflow tips for making icon compilation images, optimizing icons and embedding stylesheets:
+
See [[Guidelines and HOWTOs/Icon Workflow Tips]] for more information about size optimization, embedding stylesheets into monochrome icons, and making compilation images for putting into your review request.
https://community.kde.org/Guidelines_and_HOWTOs/Icon_Workflow_Tips
 

Latest revision as of 16:52, 7 July 2020

Get the Breeze Icons git repository

First you will need to download the breeze-icons source code repository, build it, create a personal fork of it, and set up your personal fork as a new "remote" in your local download of the git repository. Instructions for doing that can be found here: https://community.kde.org/Infrastructure/GitLab


Start working

As part of the previous step, you should have a git repository named "breeze-icons" at [your home folder]/kde/src/breeze-icons/. You can now get on with editing an existing icon or submitting a new one. Explore the folder structure inside [your home folder]/kde/src/breeze-icons/ a bit to get a feel for the structure of the repository--where things live, what kinds of icons go where, and so on. The Breeze Icon design guidelines offer more information, and helpful guidelines regarding the style you should match.

KDE icons are SVG files. We recommend the use of Inkscape or another free, open-source vector graphics editor for maximum compatibility.

How to edit an existing icon

Many KDE icons come in multiple versions that are optimized for various sizes, so once you're done editing one version, make sure to edit the others accordingly. For example, if you edit icons/actions/16/document-open-recent.svg, you will also need to edit the versions of that file present in icons/actions/22, icons/actions/16, icons/actions/24, and icons/actions/32.


How to create a new icon

To submit a new icon, first create it in your vector graphics editor, and then once you're done, save it to the appropriate place in the breeze-icons repository. For example if you are submitting a new app icon, you would save it inside [your home folder]/kde/src/breeze-icons/icons/apps/48/. If you are submitting an icon of a type that comes in multiple sizes (for example, an action icon), be sure to save each version to the correct location.


Post-processing steps

After using Inkscape to edit an icon or create a new icon, you will want to do two things before you submit your work for review

  1. Run an SVG optimizer on it. To learn how to do this, see https://community.kde.org/Guidelines_and_HOWTOs/Icon_Workflow_Tips#SVG_optimization
  2. If it is a monochrome icon, fix the internal stylesheets, which inkscape has mangled. TO learn how to do this, see https://community.kde.org/Guidelines_and_HOWTOs/Icon_Workflow_Tips#Embedding_stylesheets_in_SVGs


Submit your proposal for review

Once you have edited some icons and/or saved your proposed new icons to the appropriate places, it's time to submit a merge request so that the KDE VDG team can review it. Type the following commands in your terminal window, pressing the enter or return key after each line, as before:

cd ~/kde/src/breeze-icons/
git checkout -b some-name-of-your-choosing-for-this-git-branch
git add .
git commit
[now enter a good commit message]
git push fork

After you push the new commit to your fork using the last command, the terminal window will display a link you can visit to create a Merge Request. You can control-click on that link to open it directly in your web browser.

To finalize submitting your merge request, see https://community.kde.org/Infrastructure/GitLab#Create_the_Merge_Request


What happens next

Members of the KDE VDG team will review your patch and propose improvements. This is a conversation that you can and should participate in! If changes are requested, you should make those changes in your local breeze-icons git repo and push them to your fork. To learn how to do this, see https://community.kde.org/Infrastructure/GitLab#What_happens_next.3F.

Keep going until your reviewers are happy. At that point the merge request will be merged and you'll officially be a KDE contributor!


Tips and tricks

Also, it's helpful if you go through the full development environment setup (https://community.kde.org/Get_Involved/development#One-time_setup:_your_development_environment) This will allow you to compile the tests in the Breeze Icons repo and then run them:

kdesrc-build breeze-icons
cd ~/kde/build/breeze-icons/
ctest

See Guidelines and HOWTOs/Icon Workflow Tips for more information about size optimization, embedding stylesheets into monochrome icons, and making compilation images for putting into your review request.


This page was last edited on 7 July 2020, at 16:52. Content is available under Creative Commons License SA 4.0 unless otherwise noted.
-->