Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Slugs to Contributing Guidelines #5150

Merged
merged 4 commits into from
Mar 4, 2021

Conversation

PeterShaggyNoble
Copy link
Member

Issue: Follow-up to #4946, #4918 & #5002
Alexa rank: n/a

Checklist

  • I updated the JSON data in _data/simple-icons.json
  • I optimized the icon with SVGO or SVGOMG
  • The SVG viewbox is 0 0 24 24

Description

This PR adds a line to the optional JSON data section about how to add a custom slug to an icon's entry and a new bullet point to the filename convention section on how to resolve naming conflicts.

I also moved the section on file names up above the section on the JSON in an effort to improve the workflow. As it was, we would have been explaining how to add a slug before explaining what a slug is or how to construct it. This way the contributor will know what a slug is and what their specific icon's slug is before they get to the explanation on how to add it to the JSON.

@PeterShaggyNoble PeterShaggyNoble added the meta Issues or pull requests regarding the project or repository itself label Mar 2, 2021
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
PeterShaggyNoble and others added 2 commits March 4, 2021 11:36
Co-authored-by: Álvaro Mondéjar <mondejar1994@gmail.com>
Co-authored-by: Álvaro Mondéjar <mondejar1994@gmail.com>
@mondeja mondeja merged commit a1d4dc3 into simple-icons:develop Mar 4, 2021
@PeterShaggyNoble PeterShaggyNoble deleted the docs/slugs branch March 4, 2021 12:01
PeterShaggyNoble added a commit to PeterShaggyNoble/simple-icons that referenced this pull request Mar 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta Issues or pull requests regarding the project or repository itself
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants