Commit Graph

83 Commits

Author SHA1 Message Date
Sachin Raja
8f887a2a30
add Oracle to list of protective brands (#7565) 2022-07-04 09:52:56 -07:00
Sigurd Spieckermann
7ca13c3684
Add exclusion of brands of protective companies/organizations (#7438)
* Add exclusion of brands of protective companies/organizations

* Restructure to easily add restrictive companies/organizations

* Remove accidentally duplicated exclusion criteria
2022-05-23 16:29:29 +02:00
Andre_601
52a6a2397e
Remove IcoMoon from contributing file (#7432) 2022-05-22 14:17:13 +02:00
Sigurd Spieckermann
a2d105c1ab
Add Boxy SVG to list of vector graphics editors (#7360) 2022-04-28 21:26:50 +02:00
Sigurd Spieckermann
6553e31d3a
Advise to use GitHub file URL also when color origin differs (#7357) 2022-04-26 21:29:47 +02:00
Dalpat Rathore
95065539e4
Fix: CONTRIBUTING.md grammar (#7194)
* Fix: CONTRIBUTING.md grammar
2022-03-05 15:56:12 +01:00
Sachin Raja
d6612085c4
prefer similarweb for website ranks (#7154)
* prefer similarweb for website ranks

* Update icon_request.yml

* Update icon_request.yml

* update CONTRIBUTING.md

* format yaml

* update pull request template

* update example

* fix formatting errors
2022-02-21 12:29:48 -08:00
Eric Cornelissen
2c351f6452
Upgrade SVGLint dependency (#6970)
* Upgrade svglint from 1.3.0 to 2.0.0

* Update minimum required NodeJS version for local testing

In accordance with the new minimum required NodeJS version for SVGLint:
2d242fe57a/package.json (L52)

* Update CONTRIBUTING.md

Co-authored-by: LitoMore <LitoMore@users.noreply.github.com>
2021-12-21 19:14:29 +01:00
Álvaro Mondéjar
7e0ed7c728
Add 'Testing Package Locally' section to CONTRIBUTING toc (#6925) 2021-11-29 17:21:17 +01:00
Eric Cornelissen
668c9e49c7
Create VERSIONING.md (#6023)
* Create VERSIONING.md

* Include VERSIONING.md in NPM package

* Add note on deprecation timelines to VERSIONING.md

* Be explicit about what "support for old major versions" means

Co-authored-by: Peter Noble <petershaggynoble@gmail.com>
2021-09-30 09:33:44 +02:00
Jorge Amado Soria Ramirez
8e5f40e9bf
Updating guidelines unofficial source (#6428)
* adding Malt Icon

* reverting a commit of the Malt icon directly to develop

* proposal for amendment to address Javascript and other icons without official sources

* proposal for amendment to address Javascript and other icons without official sources

* moved the new clause to the inside of the popular brand clause

* added a clause in the official icons guidelines

* Update CONTRIBUTING.md

Co-authored-by: Álvaro Mondéjar <mondejar1994@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Sachin Raja <sachinraja2349@gmail.com>

* Update CONTRIBUTING.md

reduced the logo description to "widely accepted" rather than "well known or widely accepted de facto standard"

* removed bullet point at the insistence of Eric Cornelissen and Sachin Raja

* Update CONTRIBUTING.md

Co-authored-by: Álvaro Mondéjar <mondejar1994@gmail.com>

* changed source for Conda-Forge

* Update simple-icons.json

* Update simple-icons.json

* Update CONTRIBUTING.md

Co-authored-by: Sachin Raja <sachinraja2349@gmail.com>

Co-authored-by: jsoria <jsoria@tripadvisor.com>
Co-authored-by: Álvaro Mondéjar <mondejar1994@gmail.com>
Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com>
Co-authored-by: Sachin Raja <sachinraja2349@gmail.com>
2021-09-02 21:16:57 -05:00
P. Mergey
8cb22d7c53
Proposal for clarification about links to be included for icon source data (#6364) 2021-08-30 09:45:22 +02:00
Eric Cornelissen
2f2369b2d5
Make code snippets easier to copy (#5736) 2021-05-29 18:40:37 +01:00
Eric Cornelissen
c368b14e62
Remove (old) website source files (#5553)
* Remove files directly related to the website

Remove all the files directly related to the Jekyll-based website in
this repository. This includes the HTML, CSS and JS for the website, the
assets that can be found in the images/ folder, Jekyll-related files
(_config.yml, Gemfile, Gemfile.lock) and the CNAME file.

* Remove website-related configurations

Remove website-related files from ignore files, update the EditorConfig
configuration to remove any mention of website files, and update
.gitattributes to omit removed files.

* Update issue templates

Remove the issue templates for issues regarding the website and replace
it with a issue templates configuration file [1] that provides a link to
a the equivalent issue template in the simple-icons-website repository.

--
1. https://docs.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository


* Remove building website from verify workflow

* Remove mentions of website from Contributing Guidelines

* Remove mention of GitPod

I believe the main advantage of GitPod was that it allows you to preview
a contribution in the context of the website. Now that the website is no
longer in the repository this is not a thing anymore (unless someone
can configure GitPod to pull in the website from its repo), so I removed
any mention of it.

I'm open to reverting this change if contributors still want to use
GitPod.

* Add CI job for building the NodeJS package
2021-05-29 18:00:40 +02:00
Adam Rusted
c15eb68691
Add DISCLAIMER.md (#4912)
Co-authored-by: Peter Noble <PeterShaggyNoble@users.noreply.github.com>
Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com>
Co-authored-by: Álvaro Mondéjar <mondejar1994@gmail.com>
2021-05-29 17:46:31 +02:00
Peter Noble
521c96fd04
Remove "icon" suffix from SVG titles (#5616) 2021-05-26 22:20:20 +02:00
Peter Noble
b2e16a4748
Update Alexa Rank Info in Contributing Guidelines (#5775) 2021-05-25 22:11:16 +02:00
Peter Noble
13b2adb7e3
Update trademark guidelines in CONTRIBUTING.md (#5612)
* Update trademark guidelines in CONTRIBUTING.md

* Change order of bullets
2021-05-10 10:30:28 -04:00
Eric Cornelissen
eabafcb165
Fix the localization example in the Contributing Guidelines (#5629) 2021-05-07 16:25:12 +01:00
Eric Cornelissen
979836137d
Add aliases to the JSON schema (#5369) 2021-05-06 14:50:44 +01:00
Peter Noble
ead1170a2f
Disallow Hyphens in File Names (#5121) 2021-05-05 11:22:54 +01:00
Dzintars Klavins
beb1cd2c2f
Add Lit icon and fix typo in the Contributions guidelines (#5571) 2021-05-02 17:45:30 +01:00
Peter Noble
a1d4dc3a13
Add Slugs to Contributing Guidelines (#5150)
* Add Slugs to Contributing Guidelines

* Reword description of slug entry in JSON

* Update symbol table alignment

* Add quotation marks to brand name when running get-filename
2021-03-04 12:58:23 +01:00
Eric Cornelissen
693e626649
Update text on optional JSON data in Contributing Guidelines (#5068) 2021-03-01 12:16:24 +00:00
Benno Bielmeier
4997d9cc7b
Update number of optimization ways in CONTRIBUTE.md (#5128) 2021-02-27 12:20:27 +01:00
Eric Cornelissen
c083192150
Improve Contributing Guidelines for Git, GitHub, and SVG beginners (#5101) 2021-02-25 11:43:58 +00:00
Eric Cornelissen
39269e7d39
Add icon license to JSON linting (and change JSON linting dependency) (#4945)
* Add "license" object to the data file JSON schema

* Add license to GNU and GNU social

As an example, based on the discussion in:
https://github.com/simple-icons/simple-icons/issues/1167

* Use `"additionalProperties": false` in JSON schema

... to detect properties in the data file that shouldn't be there.

For more info, see:
https://json-schema.org/understanding-json-schema/reference/object.html

* Update JSON scheme descriptions

* Switch from jsonlint2 to jsonschema

This gives is better support for advanced features of JSON schema.

A couple of clarifications:
- There does exist a jsonschema-cli package, but it is rather limited
  and crucially doens't exit with a non-zero exit code if there is an
  error. (it is also pretty old and not maintained), hence the custom
  script.
- I renamed .jsonlintschema 1) for clarity (lint is no longer accurate)
  and 2) the .json extension allows easy imorting in the script and 3)
  it adds syntax highlighting.
- The script outputs the number of errors in the end because the output
  gets pretty big pretty quickly, this way you can see it easily from
  your CLI.
- We could customize how the errors are logged, but I feel that is
  beyond this PR.

* Two minor changes

* Use `oneOf` to require URL for custom licenses

The updated configuration allows the `"license"` field to be either
1) a SPDX license, optional with a URL
2) a "custom" license with a required URL

Read more about the "oneOf" feature of jsonschema at:
https://json-schema.org/understanding-json-schema/reference/combining.html#oneof

* Include license field in Contributing Guidelines
2021-02-19 15:19:22 +01:00
Eric Cornelissen
9fed7b6ebf
Keep track of brand guidelines/presskits/etc. explicitly (#2846)
Co-authored-by: Peter Noble <PeterShaggyNoble@users.noreply.github.com>
2021-01-17 21:41:03 +00:00
Álvaro Mondéjar
74ff55fdab
Specify recommended continuous monochromatic geometries treatment (#4566)
* Specify recommended continuous monochromatic geometries treatment

* Spelling & Grammar

Co-authored-by: Adam Rusted <hello@adamrusted.me>
2021-01-02 17:03:47 +01:00
Álvaro Mondéjar
8cc2acf670
Unlocalize SVG editors links in contribution guidelines (#4563) 2021-01-01 22:57:54 +01:00
Álvaro Mondéjar
05f4e8fd26
Fix SVG tag error in contributing guidelines (#4529) 2020-12-29 15:12:32 +00:00
Eric Cornelissen
4e199bb87b
Suggest using "Treeless clone" to contributors (#4433)
* Suggest using "Treeless clone" to contributors

Following a recent GitHub blog post [1], this adds a suggestion to the
Contributing Guidelines to use a "Treeless clone" when cloning this
repository. Since the commit history is generally not super important to
contributors, this can significantly speed up cloning without any real
downside.

--
1. https://github.blog/2020-12-21-get-up-to-speed-with-partial-clone-and-shallow-clone/

* Add HTTPS version for cloning the repository

* Add comments and highlighting for cloning snippet

* Add clone instruction for using GitHub CLI

* Increase spacing
2020-12-23 19:21:17 +01:00
Álvaro Mondéjar
740dfba419
Formalize website Ruby dependencies and installation process (#4416)
* Formalize website Ruby dependencies and installation process

* Improve Contributing Guidelines

* Add Gemfile.lock to .gitattributes

* Use 'ruby/setup-ruby' caching strategy

* Add link to documentation of 'bundler-cache'
2020-12-22 21:11:57 +01:00
Florian Bernhart
e3e590b5e9
Update contribution guidelines regarding requests for musicians, sport clubs, universities, government agencies, ... (#4373) 2020-12-18 16:40:15 +01:00
Álvaro Mondéjar
fb2e2b6cd0
Add lint rule to prohibit negative zeros within paths (#4350)
* Add lint to check negative zeros in paths

* Bump minimum NodeJS version to test locally to v12.4.0

* Simplify regular expression

* Add resolution tip to error message

* Convert iterator to array directly

* Improve comment

* Remove GodotEngine from lint ignores file

* Improve resolution tip message if previous character is a number
2020-12-14 20:35:27 +01:00
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 
32993385daad3a66d6a2f8094c1dde5c33d2a03b 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 55e4070b3c3294cff306fcc138ce247843130c35.

* Explain in CONTRIBUTION.md how to sort metadata
2020-01-16 12:40:46 +02:00