Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
111 lines (74 loc) · 4.43 KB

CONTRIBUTING.md

File metadata and controls

111 lines (74 loc) · 4.43 KB
Raw

Contributing to Chain.Love

! We recommend using "Contributor" wizard available at https://app.chain.love/contributor.

This repository is intentionally CSV-first so contributors can edit data in spreadsheet tools without programming knowledge.

Start here (required)

Before editing data, read the Style Guide:

Data model

provider -> offer -> listing

  • references/providers/providers.csv: provider identity metadata.
  • references/offers: canonical offer templates.
  • listings/specific-networks/<network>: listings for one network.
  • listings/all-networks: listings merged into every network output.

Where to edit

Goal Edit here
Add/update provider profile metadata references/providers/providers.csv
Add/update provider logo files references/providers/images/
Add/update reusable offer (product/plan) references/offers/<category>.csv
Add/update an offer on one chain listings/specific-networks/<network>/<category>.csv
Add/update entries for every chain listings/all-networks/<category>.csv
Add a new network listings/specific-networks/<network>/ — CSV files and chain logo PNGs (see below)
Add/update chain logo for a network listings/specific-networks/<network>/<chain>.png

How references work

  • Category CSV files use separate columns: provider and offer.
  • In references/offers/*.csv, set provider to the provider name/slug and offer to the offer name.
  • In listings CSV files, reference canonical offers with !offer:<slug> in the offer column.
  • During JSON generation, referenced fields are hydrated from references/offers/<category>.csv.
  • Values in the listing row override hydrated values where provided.
  • Rows from listings/all-networks are appended to every network output.

Link formatting convention

  • In references/offers/*.csv (for example actionButtons), keep Markdown link style (for example [Website](https://example.com)).
  • In references/providers/providers.csv, keep plain links only (no Markdown wrappers).
  • Use full URLs for website and docs.
  • For platform columns with known domains (x, github, discord, telegram, linkedin), store only the part after the domain.
    • Example: https://github.com/Chain-Love/chain-love -> Chain-Love/chain-love

Chain logo images

Each listings/specific-networks/<network>/ folder contains PNG logo files named after the chain values used in that network's CSVs (for example mainnet.png, testnet.png).

When adding a new network or a CSV that introduces a new chain value, include the corresponding <chain>.png in the same PR.

Requirements:

  • PNG format, transparent background, square aspect ratio, 160–500 px per side.
  • No solid-colour backgrounds (white, black, etc.).
  • See listings/specific-networks/README.md for the full spec and logo source suggestions.

Contribution workflow

  1. Fork this repository and create a descriptive branch (example: add-ankr-offer).
  2. Edit the correct CSV based on the table above.
  3. Validate locally (optional) or rely on CI checks.
  4. Open a PR with a clear description and links to sources for changed data.

Local validation (optional)

Our CI will automatically run on every commit you make in an open PR and verify if your patches don't break anything. However, to make your contribution cleaner - you can make your computer run the same verifications locally before every commit.

Install and enable pre-commit:

  1. Install python3.
  2. Install pipx.
  3. Install pre-commit with pipx install pre-commit.
  4. Run pre-commit install in the repository root.

Verification commands:

python3 --version
pipx --version
pre-commit --version

Platform-specific install links:

Reporting issues

Use GitHub Issues.

  • Bug Report: broken database structure or Chain.Love website issue.
  • DB Improvement Proposal (DBIP): suggested data model changes (categories, tables, columns).
  • Blank Issue: anything else.

Grant program and rewards

See the Grant Program. Database contributions may be eligible for USDT/USDC rewards under certain conditions.