Cards / playbooks / test-it-and-share-it

Test it and share it

Chapter 2 of Edgible for Contributors. New: the prompts are still being run end to end, so tell us how it goes.

Before a card reaches the catalog, it's tested on your own Edgible. Then it goes to us as a pull request, we test it again, and it's listed for everyone.

What you need

  • The card from Make your app a card.
  • Edgible on a machine of yours, where the test runs. A spare computer or a small virtual machine will do. Nothing of ours is touched.
  • A GitHub account, for the pull request.

1. Test it on your own Edgible

Test my card end to end.

Your assistant runs the card's whole life on your machine: check, start, publish, verify, and tear down, the same test our nightly run uses. It shows you the result. If something fails, it fixes it and tests again. The result is saved with the card, and goes into your pull request.

2. Decide who answers for it

Every card shows who looks after it. Put your GitHub name on yours and it says Stewarded by you: you review changes to it, and fix it if its test fails.

Prefer not to? It can be listed with No steward. It's still tested every night, and if its test fails, it's shown dimmed until it passes.

3. Open the pull request

Share my card: open a pull request to the Edgible cards.

It asks you first, as it does for anything that leaves your machine. Then it opens the pull request from your own copy of the cards, with the test result in it. Read what it wrote: you're the one asking for it to be listed.

4. What happens next

A person at Edgible reads the card and tests it again on our own machines. That's done by hand, so it isn't instant. Once it's merged, it's listed, and the nightly test keeps checking it.

What you've just done

Stuck, or not sure it's ready? Open an issue (opens in a new tab) with what you built and where you got to, or write to us on the contact page (opens in a new tab).

Prefer to do it by hand?

The test is card-kit's test-card, run on the machine with Edgible, from a clone of your fork of edgible-org/cards (opens in a new tab) with card-kit beside it:

python3 ../card-kit/test-card.py <name> --device <your-device>
../card-kit/run check-cards --fresh

Then commit the card with the test.yml it wrote, and open the pull request from your fork. The contributing guide (opens in a new tab) has every step.

This page as Markdown, for your AI assistant