Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/showcase.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Add a site to the showcase
description: Have you adopted solid-route-progress? Tell us where.
title: 'Showcase: '
labels: [showcase]
body:
- type: markdown
attributes:
value: |
Prefer to send it yourself? [Add a file on GitHub](https://github.com/kecan0406/solid-route-progress/new/main?filename=www%2Fshowcase%2Fmy-site.json&value=%7B%0A++%2F%2F+Delete+the+%2F%2F+lines+before+you+propose+the+change.%0A++%2F%2F+The+site%27s+domain+or+name.%0A++%22name%22%3A+%22%22%2C%0A++%2F%2F+Starting+with+https%3A%2F%2F%0A++%22url%22%3A+%22https%3A%2F%2F%22%2C%0A++%2F%2F+One+line+on+what+the+site+is.%0A++%22description%22%3A+%22%22%0A++%2F%2F+Optional+logo%3A+drop+the+file+in+a+comment+on+your+pull+request%2C+and+we+add+these.%0A++%2F%2F+%22image%22%3A+%22%2Fimg%2Fshowcase%2Fyour-site.svg%22%2C%0A++%2F%2F+%22credit%22%3A+%7B%0A++%2F%2F+++%22text%22%3A+%22Logo+by+Jane+Doe%22%2C%0A++%2F%2F+++%22url%22%3A+%22https%3A%2F%2Fexample.com%2Fjane%22%2C%0A++%2F%2F+++%22license%22%3A+%22CC+BY+4.0%22%2C%0A++%2F%2F+++%22licenseUrl%22%3A+%22https%3A%2F%2Fcreativecommons.org%2Flicenses%2Fby%2F4.0%2F%22%0A++%2F%2F+%7D%0A%7D%0A) and GitHub opens the pull request for you.
- type: input
id: name
attributes:
label: Name
description: The site's domain or name.
placeholder: example.com
validations:
required: true
- type: input
id: url
attributes:
label: URL
placeholder: https://example.com/
validations:
required: true
- type: input
id: description
attributes:
label: Description
description: One line on what the site is.
placeholder: A social network for hackers.
validations:
required: true
- type: textarea
id: mark
attributes:
label: Mark
description: Optional. Drag your logo here (SVG or PNG), and say where it comes from and under which license.
- type: checkboxes
id: live
attributes:
label: Confirm
options:
- label: The site runs solid-route-progress in production.
required: true
1 change: 1 addition & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!-- For anything larger than a bug fix, please open an issue first. See CONTRIBUTING.md. -->
<!-- Adding a site to the showcase (a file in www/showcase/)? Name the site below and skip the checklist. -->

## What changes

Expand Down
32 changes: 31 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Contributing

Thanks for taking the time to contribute. This guide covers what you need to set up the project and
what a pull request should include.
what a pull request should include. To add your site to the showcase, skip to
[Add a site to the showcase](#add-a-site-to-the-showcase): it takes one small file and no setup.

## Prerequisites

Expand Down Expand Up @@ -73,6 +74,35 @@ page with `pnpm build:www`.
- If your change affects the published package, run `pnpm changeset` and describe it for the release
notes. Docs-only and tooling-only changes do not need one.

## Add a site to the showcase

The [showcase](https://solid-route-progress.vercel.app/showcase) lists sites that run
solid-route-progress in production. Each site is one JSON file in `www/showcase/`:

```json
{
"name": "hackers.pub",
"url": "https://hackers.pub/",
"description": "ActivityPub-enabled social network for hackers."
}
```

`image` is optional: a mark shown left of the name, as a file in `www/public/img/showcase/`
referenced as `/img/showcase/<file>`. You do not have to add it yourself. Drop your logo (SVG or PNG)
in a comment on your pull request, or in the showcase issue form, and say where it comes from and
under which license. We commit the file, note the license in the `README.md` next to it, and add a
`credit` (the maker and the license, each with a link) that the card shows under the site.

The quickest way needs no clone:
[add the file on GitHub](https://github.com/kecan0406/solid-route-progress/new/main?filename=www%2Fshowcase%2Fmy-site.json&value=%7B%0A++%2F%2F+Delete+the+%2F%2F+lines+before+you+propose+the+change.%0A++%2F%2F+The+site%27s+domain+or+name.%0A++%22name%22%3A+%22%22%2C%0A++%2F%2F+Starting+with+https%3A%2F%2F%0A++%22url%22%3A+%22https%3A%2F%2F%22%2C%0A++%2F%2F+One+line+on+what+the+site+is.%0A++%22description%22%3A+%22%22%0A++%2F%2F+Optional+logo%3A+drop+the+file+in+a+comment+on+your+pull+request%2C+and+we+add+these.%0A++%2F%2F+%22image%22%3A+%22%2Fimg%2Fshowcase%2Fyour-site.svg%22%2C%0A++%2F%2F+%22credit%22%3A+%7B%0A++%2F%2F+++%22text%22%3A+%22Logo+by+Jane+Doe%22%2C%0A++%2F%2F+++%22url%22%3A+%22https%3A%2F%2Fexample.com%2Fjane%22%2C%0A++%2F%2F+++%22license%22%3A+%22CC+BY+4.0%22%2C%0A++%2F%2F+++%22licenseUrl%22%3A+%22https%3A%2F%2Fcreativecommons.org%2Flicenses%2Fby%2F4.0%2F%22%0A++%2F%2F+%7D%0A%7D%0A),
fill in the three fields, and propose the change. GitHub forks the repository and opens the pull
request for you. If you would rather fill in a form, use the
[showcase issue](https://github.com/kecan0406/solid-route-progress/issues/new?template=showcase.yml)
instead.

CI builds the site, and the build fails with the file and the field if an entry does not fit. A
showcase entry needs no tests, docs, or changeset.

## Releasing

Releases are automated with changesets and npm trusted publishing, so nobody publishes from a
Expand Down
13 changes: 13 additions & 0 deletions www/public/img/showcase/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Showcase images

Each file is a site's mark, shown left of its name on the showcase card (`image` in
`www/showcase/<site>.json`). Every image keeps its own license, so note it here.

## hackers-pub.svg

The cat motif from [hackers-pub/visual-identity](https://github.com/hackers-pub/visual-identity),
`exports/pubnyan-normal-border.svg`, unmodified.

Visual Identity of Hackers' Pub 漏 2025 by Bak Eunji, licensed under
[CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/). The credit is on the card, from
`credit` in `www/showcase/hackers-pub.json`. The license grants no trademark rights.
Loading
Loading