Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
79 lines (55 loc) · 4.19 KB

CONTRIBUTING.md

File metadata and controls

79 lines (55 loc) · 4.19 KB

Contribution Guide

Add your sites to Hypertext TV.

What sites do you accept?

We'll air handmade websites of any size! Games, personal sites, art, poetry, interactive experiences, toys, explorations—anything special. It can be a small as a single photo of a potato or as large as an interactive explorable about mechanical watches.

Important

Acceptance criteria:

  1. No sites promoting racism, homophobia, transphobia, sexism, fatphobia, or other assholery
  2. No links to large platforms like YouTube, Instagram, Spotify, Soundcloud, Medium, etc.
  3. No marketing sites or anything with ads
  4. No AI-generated content
  5. No insecure sites (sites must use the https:// protocol)

Right now, all sites on HTTV must be in English. However, there is an open discussion about accepting non-English sites. If you have a site in a language other than English which you want to submit, please add it to the discussion thread so I can gauge interest.

How do I add my site?

Create a pull request against this repository by forking it or by editing the file from the GitHub interface.

  1. Go to src/channels.
  2. This folder contains .yml files which define the airing schedule for each channel: games, art, music, personal, poetry, single-use, explorables, archives, and misc. Select a channel for your site and open its .yml file.
  3. Find a day and time within schedule for your website to air.
  4. Add your site details. For example:
- wednesday:
  - "14:00": 
      title: Design Is 
      # (Optional) Your name, nickname, or handle
      # To be displayed on the credits page
      author: Ky Decker 
      # A link to your website, using https://
      url: https://design.ky.fyi

      # Important: YAML is whitespace-sensitive.
      # Make sure your entries are indented 2 spaces beneath the time block!

If you need to credit multiple authors, you can do so like this:

- friday:
  - "16:30"
      title: Ear Association
      author:
        - Evy Kassirer
        - Jacob deGroot-Maggetti
      url: https://ear-association.github.io/

      # Again: make sure YAML is indented correctly!
  1. Save and commit your changes, then open a pull request.
  2. Your change will be reviewed. If everything looks good, it'll deploy to Hypertext TV! Enjoy seeing your site air each week.

Previewing your site

To preview your site, visit hypertext.tv/test and enter your site URL.

Note

Hypertext TV displays sites using iframe. If your domain explicitly blocks cross-origin resource sharing, we won't be able to display your site on the TV. To fix this, you need to modify or remove the HTTP X-Frame-Options response header on your server.

What time block should I pick?

That's up to you! Times are stored in Coordinated Universal Time (UTC), so if you want your site to air at a particular local time, make sure you translate the time between local and UTC first. Here's a helpful conversion tool for UTC to local time.

Programs can only be scheduled at :00 or :30. Programs will air continuously until the next scheduled program or the end of the day, whichever is first.

Can I submit more than one site?

If you have multiple sites that meet the criteria, please do!

I have a site I want to add, but I'm not sure how to submit through GitHub. Is there another way?

Send me an email (hi@ky.fyi) with your website, channel, and requested time, and I'll add it!