Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
128 lines (91 loc) · 3.96 KB

CONTRIBUTING.md

File metadata and controls

128 lines (91 loc) · 3.96 KB

Contributing to Allogo

First off, thank you for considering contributing to Allogo! It's people like you that make this tool useful for the developer community.

Table of Contents

Requesting a Logo

If you don't have the logo yourself but want to see one added:

  1. Search First: Ensure the logo doesn't already exist in the Allogo library.
  2. Check Existing Issues: Someone might have already requested it.
  3. Open an Issue: Use the Logo Request template. Provide as many details as possible, especially links to official brand headers or press kits.

Adding or Updating a Logo

1. Guidelines

To ensure high quality, please follow these rules:

  • Format: We accept SVG, PNG, and JPG formats.
    • SVG (Preferred): Vector format enables component code generation for React, Vue, Angular, Svelte.
    • PNG/JPG: Raster formats are supported for download only (no component code generation).
  • SVG Guidelines:
    • Must contain vector paths. No embedded raster images (PNG, JPEG inside SVG).
    • Remove unnecessary metadata, comments, and hidden layers.
    • Simplify the viewBox if possible.
    • Ensure the SVG renders correctly on both light and dark backgrounds.
  • PNG/JPG Guidelines:
    • Minimum resolution: 256x256 pixels.
    • Transparent background preferred for PNG.
  • Naming: The directory name (slug) should be lowercase, using hyphens for spaces (e.g., visual-studio-code NOT Visual Studio Code).

2. Forbidden Brands

We respect the intellectual property and strict brand guidelines of certain companies. We do not accept logos from the following brands/organizations as they are known for aggressive brand protection:

  • Disney (including Marvel Comics, Pixar, Star Wars, etc.)
  • Olympics (IOC)
  • Other strictly protected brands (e.g., heavily litigious entities)

Note: Tools like "Marvel App" (prototyping tool) are allowed as they are distinct from Marvel Comics.

3. Step-by-Step Guide

Step 1: Prepare the SVG

Find the official logo. A good source is the company's "Press Kit", "Brand Assets", or valid vector repositories. Save it as icon.svg, icon.png, or icon.jpg depending on format.

Step 2: Add to Project

  1. Create a new directory in public/logos/: 
    mkdir public/logos/my-new-tool
  2. Place your icon.svg inside this folder.

Step 3: Update Database

We provide a script to assist you. You don't need to edit the JSON manually for the initial entry.

  1. Run the update script:

    node scripts/update-logos.js

    This will scan the folders and add any missing entries to src/data/logos.json.

  2. Manual Review: Open src/data/logos.json, find your new entry, and ensure the details are correct:

    • Name: Use proper capitalization (e.g. "MyBrand").
    • Website: Add the official URL.
    • Categories: Add relevant tags (e.g. ["ai", "framework", "database"]).

Step 4: Verify

Run the development server and check if your logo appears and renders correctly.

pnpm run dev

Step 5: Submit

  1. Commit your changes: 
    git add public/logos/my-new-tool src/data/logos.json
git commit -m "Add MyNewTool logo"
  2. Push to your fork.
  3. Open a Pull Request!

Development

If you want to improve the codebase (feature or bug fix):

  1. Clone the repo: 
    git clone https://github.com/callback-io/allogo.git
  2. Install dependencies: 
    pnpm install
  3. Run locally: 
    pnpm run dev
  4. Lint & Test: 
    pnpm run lint

Thank you for contributing!