Introduce Icon Policy Documentation

jarolrod commented at 3:46 am on May 3, 2021: member

Picking up #178

This introduces documented policies for how icons should be prepared, optimized, styled, contributed, and attributed within Bitcoin Core. Having guidelines for iconography helps with making applications more consistent and efficient.

Changes from 35f302d8be542784a9c957c2635f264d92a2b92e:

Remove references to named Vector processing tools (https://github.com/bitcoin-core/gui/pull/178#discussion_r556663747)
Explicitly state PNG’s must be processed by the optimize-png.py script (https://github.com/bitcoin-core/gui/pull/178#discussion_r554538058)
Suggestions (https://github.com/bitcoin-core/gui/pull/178#pullrequestreview-603765896)
Various markup fixups

Rspigler commented at 4:00 am on May 3, 2021: contributor

Concept ACK ec57f6e2ab86ad33501441ab2241c5428ea65741

in src/qt/res/README.md:16 in ec57f6e2ab outdated

11+#### PNG Production File
12+PNGs are used in production due to wide application support, transparency support, and better image quality compared to competing file types
13+such as JPEG.
14+
15+### Icon Grid
16+Bitcoin Core uses an 8-point grid system for its icons which utilizes size increments of 8px to visually orientate elements within a grid. The majority of screen sizes are divisible by 8, which makes fitting elements easier using an 8-point grid system. This system makes things more efficient for designers and aids in maintaining consistency across applications.

Bosch-0 commented at 4:03 am on May 3, 2021:

jarolrod commented at 4:15 am on May 3, 2021:

You no longer want this section in there?

Bosch-0 commented at 4:29 am on May 3, 2021:

Nah these details are all in the Bitcoin icons repo.

in src/qt/res/README.md:26 in ec57f6e2ab outdated

21+- To ensure icons look good at any scale, a minimalistic design should be used.  
22+- Icon size should be 32x32px by default. A different sized icon may be necessary under special circumstances. If the 32x32px size is too small for the required icon placement, then the icon should be scaled up or down while adhering to the 8-point grid system.
23+- The icon should avoid organic shapes or elements, these do not scale well.
24+- Colors should be consistent with existing Bitcoin Core icons.
25+- Icons should adhere to the 8-point grid system (see above).
26+

Bosch-0 commented at 4:03 am on May 3, 2021:

0### Icons
1Bitcoin Core primarily uses icons from the [Bitcoin Icon set](https://github.com/BitcoinDesign/Bitcoin-Icons). Please follow the design guidelines laid out by that project when designing icons.
2
3[Bitcoin icons](https://bitcoinicons.com/) is an open source icon set made for bitcoin applications.

jarolrod commented at 4:17 am on May 3, 2021:

Well not yet. But, we can add that in when we attempt a migration to those icons

jarolrod commented at 4:17 am on May 3, 2021:

Should I just remove the Icon Style section for now?

Bosch-0 commented at 4:28 am on May 3, 2021:

I think we should merge this a long with the updated icons from Bitcoin Icons

jarolrod commented at 4:29 am on May 3, 2021:

alright, sounds good. Made draft already.

in src/qt/res/README.md:42 in ec57f6e2ab outdated

37+
38+If a proposed feature requires a new icon, the developer should [open an issue](https://github.com/bitcoin-core/gui/issues/new/choose) requesting the new icon be designed.
39+
40+Icons, both SVG and PNG, are not to be added to Bitcoin Core prior to a production use case.
41+
42+When opening a PR that intends to add an icon, a SVG source file must be included under `src/qt/res/src`, and a optimized production file (PNG) must be included under `src/qt/res/icons`. Both source and production files should be 32x32px in size.

Bosch-0 commented at 4:12 am on May 3, 2021:

0## Contributing
1Issues and PRs pertaining to icons should be posted within the [Bitcoin Core GUI repo](https://github.com/bitcoin-core/gui). Icons should only be added to Bitcoin Core via a PR that implements the icon in its design. Icons, both SVG and PNG, are not to be added to Bitcoin Core prior to a production use case. If an icon is not being used it should be removed. 
2
3If a developer working on a new features requires an icon not currently available in the [Bitcoin Icon set](https://github.com/BitcoinDesign/Bitcoin-Icons) they should [open an issue](https://github.com/BitcoinDesign/Bitcoin-Icons/issues) in that repo requesting an icon to be designed. 
4
5SVG are to be added to `src/qt/res/src` directory, and a optimized production file (PNG) must be included under `src/qt/res/icons` directory.

jarolrod commented at 4:02 am on May 4, 2021:

Icons should only be added to Bitcoin Core via a PR that implements the icon in its design.

That line is redundant. The only way an icon would get in is through a PR.

Bosch-0 changes_requested

jarolrod marked this as a draft on May 3, 2021

jarolrod commented at 4:23 am on May 3, 2021: member

Making draft for now as it seems this will be dependent upon the introduction of BitcoinDesign/Bitcoin-Icons. When a PR is opened introducing these new icons, I’ll move this out of draft.

doc: introduce icon policy documentation

Co-authored-by: jarolrod <jarolrod@tutanota.com>

5465ce3a58

jarolrod force-pushed on May 4, 2021

jarolrod commented at 4:59 am on May 4, 2021: member

Updated from ec57f6e -> 5465ce3

Changes:

Modified version of @Bosch-0 suggestions

Bosch-0 approved

hebasto added the label Doc on May 9, 2021

in src/qt/res/README.md:38 in 5465ce3a58

33+
34+SVGs are to be included under the `src/qt/res/src` directory.
35+Optimized PNGs are to be included under the `src/qt/res/icons` directory.
36+
37+## Attribution
38+Icon additions must include appropriate attribution to the author, license information, and any comments relevant to the icon documented under the

luke-jr commented at 8:28 pm on June 12, 2021:

Maybe (re?)state licensing expectations here?

hebasto commented at 11:18 am on September 29, 2021: member

@jarolrod

What is the current status of this PR?

jarolrod commented at 5:59 am on October 26, 2021: member

moved to https://github.com/bitcoin-core/gui-qml/pull/70

jarolrod closed this on Oct 26, 2021

hebasto referenced this in commit 000ff6b979 on Nov 2, 2021

bitcoin-core locked this on Oct 26, 2022

Introduce Icon Policy Documentation #310