1
0
mirror of https://github.com/simple-icons/simple-icons.git synced 2024-12-26 01:13:41 +02:00
Commit Graph

48 Commits

Author SHA1 Message Date
Eric Cornelissen
38137f3c43
Specify guidelines on (registered) trademarks (#4278)
Specify our guidelines on whether or not to include (registered)
trademark symbols in logos as publically discussed.

This also slightly changes the document structure of the Contributing
Guidelines with the goal of making it a little bit easier to find this
new information.
2020-12-06 19:36:12 +01:00
Álvaro Mondéjar
add30d46f2
Document local testing with minimum NodeJS version required (#4151) 2020-11-29 12:57:43 +01:00
Álvaro Mondéjar
f9bac0e414
Document minimum Jekyll version required to build locally (#4116) 2020-11-23 12:23:32 +01:00
David Beitey
5da34c7efd
Add linter to check svg path dimensions (#3107)
* Add linter to check svg path dimensions

Float precision is set at 3 which is the default for svgo in .svgo.yml;
precision can be raised over time.

This adds an ignore file with the current paths of non-conforming icons.

This also changes the name of the icon title linter as well so it reads
more nicely than "custom".

* Update CONTRIBUTING GUIDELINES

Add a note on visual imperfections and viewbox problems due to 
optimizing.

Co-authored-by: Eric Cornelisesn <ericornelissen@gmail.com>
Co-authored-by: Peter Noble <PeterShaggyNoble@users.noreply.github.com>
2020-06-10 12:59:42 +03:00
Oleg Nenashev
0756e1d9a7
Add a SVGO Docker image for Simpleicons formatting (#1532)
* Add a SVGO Docker image

* Update Dockerfile and .dockerignore

Update the Dockerfile to create a docker image that is generally 
applicable to run NPM commands, including but not limited to:

- npm run test
- npm run svgo
- npm run lint

Also updated the .dockerignore file to exclude:

- The node_modules folder
- Common Jekyll folders/files
- Files generated by the build script

The reason for choosing the alpine docker image (rather than a node 
docker image) is that the CLI out of the box is better.

* Add section on using Docker to Contributing Guidelines

* Readd entrypoint for SVGO optimization to Dockerfile

Update the Dockerfile based on the original work in 
32993385da by re-adding an ENTRYPOINT to 
the Dockerfile. This ENTRYPOINT makes it extremely easy to spin up a 
quick Docker container to optimize a single SVG (much simpler than my 
copy-in -> optimize -> copy-out approach).

The description for how to use the Docker image to run other NPM scripts 
has been updated accordingly. The provided command overrides the above 
ENTRYPOINT by simple starting a shell so the user can interact with the 
project.

Co-authored-by: Eric Cornelisesn <ericornelissen@gmail.com>
2020-06-09 13:49:55 +03:00
Peter Noble
47530c59a5
Update CONTRIBUTING.md (#3111)
* Update CONTRIBUTING.md

- Add note about recating to or commenting on exsiting issues & PRs
- Add request to disclose affiliations to brands in issues & PRs

Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com>
2020-05-26 22:11:06 +02:00
Eric Cornelissen
b07f8f37cd
Add command to run all linting at once (#2966)
* Add `npm run lint` command that runs all our linting commands at once

Using npm-run-all [1], following a comment from a contributor [2].

--
1. https://www.npmjs.com/package/npm-run-all
2. 
https://github.com/simple-icons/simple-icons/pull/2958#issuecomment-616540155

* Mention new `npm run lint` command in the contributing guidelines
2020-04-27 13:34:05 +02:00
Eric Cornelissen
acd89d5e1d
Clarify we don't want overlapping paths (#2965)
Following the discussion on 69ae2c829b
2020-04-23 09:28:14 +01:00
Lucas Becker
69ae2c829b
Clearify we don't want overlapping paths.
+ add link to Affinity
2020-03-28 19:58:07 +01:00
Eric Cornelisesn
3a4535ec78 Update the Contributing Guidelines
- Remove dead link ("Labelling Issues")
- Use consistent Title Case for all titles
2020-02-28 11:37:13 +02:00
Eric Cornelissen
7ebf7f71fa
Add documentation and tooling for SVG filenames (#2601)
* Create simple CLI tool to get the filename from a brandname

https://github.com/simple-icons/simple-icons/pull/2589#issuecomment-585902427

* Update contributing guidelines on new SVGs' filenames

* Fix incorrect filename in package.json script

* Add file header to get-filename script

* Update contributing guidelines' section on SVG filenames

Co-Authored-By: YoussefRaafatNasry <youssefraafatnasry@gmail.com>
2020-02-26 17:54:54 +01:00
Eric Cornelissen
ae384e9daa
Update guidelines for source URLs (#2567) 2020-02-25 09:57:55 +00:00
Eric Cornelissen
3424fd8720
Add documentation on versioning (#2568)
* Draft documentation on versioning

* Add "Renamed icons" to kinds of changes for a major release

* Change "Updated icons" to "Updated SVGs" & "Updated metadata" for patch
2020-02-10 23:53:30 +01:00
Eric Cornelissen
2f42822167 Update CONTRIBUTING.md (#2377)
Given a recent comment on a rejected Pull Request I updated the 
Contributing Guidelines to explicitely state that adding a new icon in a 
Pull Request (without creating an issue first) is subject to the same 
requirements as an icon request by itself.
2020-01-16 12:06:13 +01:00
Johan Fagerberg
7b69d16efb Add CI step for ensuring alphabetical order of icons (#2334)
* Add a script for the linting that cannot be accomplished by our other linters

Currently this only contains linting for whether our icons are alphabetically sorted

* Add our own linting to Travis

* Fix Let's Encrypt being incorrectly sorted

* Intentionally break sorting to test CI

* Revert "Intentionally break sorting to test CI"

This reverts commit 55e4070b3c.

* Explain in CONTRIBUTION.md how to sort metadata
2020-01-16 12:40:46 +02:00
Eric Cornelissen
3af76b75d3
Add NPM script to perform SVGO optimization from the repository (#1476)
* Add SVGO as devDependencies and a NPM script to run it

* Update Contributing Guidelines

Change the instructions on how to use SVGO to optimize SVGs to use the 
new dependency and NPM script.

* Add configuration for the NPM command to optimize SVGs

* Specify --precision  in SVGO configuration file

* Update SVGO config ordering of attributes

To be in line with the fact that, as @davidklebanoff pointed out: "most 
(all?) have the attributes in the order of role, viewbox, xmlns 
(alphabetical)"

* Move SVGO --multipass argument to .svgo.yml

* Update SVGO dependency to 1.3.0

Now the force merge option works 🎉

See: https://github.com/svg/svgo/releases/tag/v1.3.0

* Update outdated "blocking" comment
2019-07-15 15:14:50 +01:00
David Klebanoff
1c0b2b1dbf Update SVG linting. Only single path SVGs allowed. (#1335)
* Update SVG linting. Only single path SVGs allowed.

* Update docs.
2019-03-28 21:40:31 +02:00
Johan Fagerberg
53d72c6cfc
Merge pull request #1270 from simple-icons/davidklebanoff-patch-1
Removed labels from Contribution Guidelines
2019-03-08 10:55:55 +01:00
David Klebanoff
d1091edfe4
Removed id attribute - it's no longer used 2019-03-07 15:50:05 -08:00
David Klebanoff
28b22b0fbe
Removed labels from contributing guidelines
They can be found on the label page.
2019-03-06 22:12:18 -08:00
Eric Cornelissen
b41eda60f7 Update issue labels table in Contributing Guidelines (#1204)
* Update issue labels table in Contributing.md

* Add "release" label to label table
2019-02-22 14:36:25 +01:00
Michael R. Crusoe
2cd101430c update svgo invocation (#1203) 2019-02-09 11:13:45 +02:00
Jan Keromnes
722e9692dc Add gitpod config (#1164) 2019-02-04 15:24:42 +02:00
Eric Cornelissen
4b882220ef Remove aria-labelledby and ids from SVGs (#1062)
* Remove `id` and `aria-labelledby` from all SVGs

* Update SVGLint configuration

* Remove `aria-labelledby` from documentation

* Remove `aria-labelledby` from website

because why not
2018-11-06 17:10:17 +01:00
Johan Fagerberg
084aeb2880 Add note on source to contribution guidelines (#1040)
Adds small note on the `source` URL
Also updates the JSON example to one that uses an optimal URL
2018-10-30 16:37:06 +01:00
Metaa
dd97f13ff4 Add a missing dash to the svgo precision option in the contributing guide (#962) 2018-08-31 11:20:46 +03:00
Eric Cornelissen
a402a50c06 Update contribution guidelines (#926)
* Add instructions to reset the SVGOMG settings if changed

* Update instructions on the precision of SVGO(MG)
2018-08-07 20:16:49 +02:00
Johan Fagerberg
f4d0b01340
Update contribution guidelines (#863)
* Update contribution guidelines

Adds mention of brand acceptance and popularity threshold

* Update contribution guidelines

As suggested by @ericcornelissen
2018-06-03 19:35:34 +02:00
Caleb King
00e213799b Add "Create a pull request" to contributing.md (#865) 2018-06-03 16:39:40 +02:00
Eric Cornelissen
4ce2ccccd7
Update CONTRIBUTING.md
Change link for svg-grabber from the git repo to the Chrome Webstore page
2018-03-14 19:38:44 +01:00
Eric Cornelissen
75c31914d5
Update CONTRIBUTING.md
Add svg-grabber with the "Website headers" option for where you can find brand logos. svg-grabber is a tool (for Google Chrome) which I recently discovered, it quickly shows you all the available SVG files on a website in order. So most of the time the company logo will be listed somewhere at the top. This might make the process of finding the SVG easier for some.
2018-03-13 20:38:28 +01:00
Eric Cornelissen
baa5fe03dd Implement suggestions by @davidklebanoff and @birjolaxew 2018-02-22 15:22:27 +01:00
Eric Cornelissen
b678094340 Update CONTRIBUTING.md
Add instructions to branch off of the develop branch and work on a
separate topic branch.
2018-02-17 23:11:15 +01:00
Eric Cornelissen
1a58d3e9e8 Add "icon outdated" label description to contributing guidelines 2017-12-22 23:35:58 +01:00
Eric Cornelissen
47c74a1f0a Make docs more "casual" (#644) 2017-10-17 13:44:38 -07:00
David Klebanoff
498ccac925 Added step about removing all colors. 2017-10-16 23:39:22 -07:00
David Klebanoff
0c318cd9d0 Added more vector file types as potential input. 2017-10-16 17:47:59 -07:00
David Klebanoff
edb27466e0 Reworked Contributing Guidelines (#640)
A big overhaul to the contribution guidelines. This should be a lot easier for new contributors to follow. Issue #630, #472, and #582.
2017-10-16 16:50:25 -07:00
David Klebanoff
d0f5b0a697 Fixed typo. 2017-10-14 15:09:07 -07:00
David Klebanoff
1078ab9ea2 Updated scaling and centering guidelines. 2017-10-14 10:31:14 -07:00
David Klebanoff
b66994c2ec Added SVGO precision guidance. 2017-10-14 10:25:22 -07:00
Collin Klippel
88bab59187 fix typo in CONTRIBUTING
deleted duplicate "remove"
2017-09-28 10:41:16 -04:00
Johan Fagerberg
2ec32bc7a1 Fixed typo in CONTRIBUTING 2017-09-06 14:31:07 +02:00
Johan Fagerberg
d183067776 Updated ARIA guidelines
Following issue from #503
2017-09-06 13:23:41 +02:00
Eric Cornelissen
5971f93548 Use jekyll serve in build instructions 2017-08-17 15:01:30 +02:00
Eric Cornelissen
138cca3e6c Add building instructions to CONTRIBUTING.md 2017-08-17 13:34:58 +02:00
Benjamin Willems
14382822e5 Add role="img" attributes to contributing guidelines and GitHub SVG 2017-06-19 09:07:37 -06:00
Benjamin Willems
3691bed216 Add draft of CONTRIBUTING.md and use GitHub svg as example reference 2017-06-16 18:16:09 -07:00