web/simple-icons
1
0
Fork 0
mirror of https://github.com/simple-icons/simple-icons.git synced 2024-12-16 01:10:30 +02:00
Code Releases Activity

Update CONTRIBUTING.md (#3111)

Browse Source 
* 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>
This commit is contained in:
Peter Noble 2020-05-26 21:11:06 +01:00 committed by GitHub
parent 32d9d1e65b
commit 47530c59a5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -18,7 +18,7 @@ Simple Icons welcomes contributions and corrections. Before contributing, please
We welcome icon requests. Before you submit a new issue please make sure the icon:
* Has not already been requested.
* Has not already been requested. If you find an existing issue or pull request for the brand you're looking for then please add a reaction or comment to show your support.
* Is of a _popular_ brand. For websites, the [Alexa rank](https://www.alexa.com/siteinfo) should be less than 500k. For anything else, popularity will be judged on a case-by-case basis.
* Isn't related to anything that provides an illegal service (e.g. piracy, malware, threatening material, spam, etc.).
@ -32,6 +32,8 @@ When submitting a request for a new or updated icon include helpful information
* **Issue Body:** Links to official sources for the brand's icon and colors (e.g. media kits, brand guidelines, SVG files etc.)
If you have an affiliation to the brand you are requesting that allows you to speak on their behalf then please disclose that in your issue as it can help speed up our research process.
## Adding or Updating an Icon
**Note**: If you decide to add an icon without requesting it first, the requirements above still apply.
@ -205,6 +207,8 @@ In general, make sure the URL does not contain any tracking identifiers.
Once you've completed the previous steps, create a pull request to merge your edits into the *develop* branch. You can run `npm run lint` to check if there are any issues you still need to address.
If you have an affiliation to the brand you contributing that allows you to speak on their behalf then please disclose that in your pull request as it can help speed up our research and review processes.
## Building Locally
* Make sure you have [Ruby](https://www.ruby-lang.org/en/downloads/) installed.