opensource/dashboard-icons
1
0
Fork 0
mirror of https://github.com/walkxcode/dashboard-icons.git synced 2025-06-27 23:10:22 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
dashboard-icons/CONTRIBUTING.md
Bjorn Lammers 27980bc6be
docs: improve documentation and branding for dashboardicons.com 
- Rewrite README with better structure and new branding
- Update contributing guidelines for clarity
- Revise code of conduct for better readability
- Add preview video asset
2025-04-17 18:04:55 +02:00

3.4 KiB
Raw Permalink Blame History

Contributing to Dashboard Icons

Thank you for your interest in contributing to our icon collection! These guidelines will help ensure smooth collaboration and maintain the quality of our collection.

Table of Contents

Icon Specifications

Format Requirements

  • SVG Format: All icons must be submitted in SVG format
  • Auto-Generated Formats: PNG and WEBP versions are generated automatically with:
    • Height: 512 pixels
    • Width: Auto (maintaining aspect ratio)
    • Transparency: Enabled

Quality Standards

  • Clean SVG: No embedded raster images in SVG files
  • Proper Cropping: Remove empty space for proper centering
  • No Upscaling: Maintain original quality without artificial enlargement

Light & Dark Variants

For monochrome or single-color icons:

  • Light Variant: Required for dark backgrounds
    • Invert black elements
    • Adjust colors for visibility
  • Dark Variant: Required for light backgrounds
    • Invert white elements
    • Adjust colors for visibility

Tool Recommendation: DEEditor for color adjustments

File Naming

  • Kebab Case: Use lowercase with hyphens
    • Example: "Nextcloud Calendar" → nextcloud-calendar.svg
  • Variant Suffixes:
    • -light for dark backgrounds
    • -dark for light backgrounds

Requesting New Icons

To request a new icon:

  1. Create an Issue:

    • Use the appropriate issue template
    • Choose between "Light & dark icon" or "Normal icon" template

  2. Provide Information:

    • Service/application name
    • Official logo or icon source
    • Any specific requirements or notes

  3. Upload Icon (optional):

    • Attach the SVG file directly to the issue
    • Include both light and dark variants if applicable

  4. Wait for Review:

    • Our team will review your request
    • We may request adjustments if needed
    • Once approved, we'll add the icon to the collection

Improving the Repository

To contribute to the repository itself:

  1. Fork the Repository

  2. Make Your Changes:

    • Documentation improvements
    • Website enhancements
    • Repository maintenance
    • Bug fixes

  3. Submit a Pull Request:

    • Use semantic commit messages following the format: <type>(scope): description
      • feat(icons): add nextcloud-calendar
      • fix(website): correct icon preview
      • docs(readme): update installation instructions
    • Reference any related issues
    • Follow our Code of Conduct

Code of Conduct

By contributing, you agree to abide by our Code of Conduct. Please review it to understand the expectations for all participants.

Questions?

If you have any questions or need assistance, contact us at homarr-labs@proton.me.