Skip to content

📌 Start here: how to add a hackathon winner #1

Description

@notsointresting

Welcome! HackWinnerDB is an open database of projects that won hackathons. The main way to contribute is to submit a winner you know about.

The only hard rule

Every winner needs a public source URL that confirms the award. A Devpost winner gallery, an organizer announcement, an official blog post, or a results page. No source, no entry.

Three ways to contribute

1. No code (2 minutes) — open the Add a hackathon winner form. Give the hackathon, year, project, award, and source URL. A maintainer converts it to data.

2. Pull request with help from the CLI

npm install
npm run add:winner       # answers the prompts, writes the YAML for you
npm run validate:data
npm run check:duplicates

Then open a PR. One event per PR keeps review fast.

3. Write the YAML by hand — see DATA_GUIDELINES.md.

What we will not accept

  • Winners with no public source
  • Descriptions copied from Devpost, blogs, or README files — write your own two sentences
  • Free-text technologies or categories; use the slugs in data/taxonomies/
  • Participation with no award

Questions? Comment here.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood entry point for new contributorshelp wantedExtra attention is needed

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions