<pcb-art/>

<submit-your-art/>

Submissions go through GitHub, but you don't need git or any tools installed, because the whole thing works in your browser. All it takes is a free GitHub account.

1. fork the repo

   Open robrotics/pcb-art → fork and hit Create fork. A fork is your own copy of the gallery repo that you're free to edit.

2. create your piece folder

   In your fork, open the art/ folder and hit Add file → Create new file. In the filename box, type your-piece-name/piece.json. The slash creates the folder. Use only lowercase letters, digits, and dashes for the folder name; it becomes your piece's ID. Paste this in and fill in your details:

   {
     "title": "My Piece Title",
     "author": "your name or handle",
     "description": "optional one-liner shown on the gallery card",
     "tags": []
   }

   Commit the file with the green Commit changes button.

3. upload the art files

   Inside your new folder, hit Add file → Upload files, drag your files in, and commit. Each file must be under 3 MB:

   • the art itself (required): at least one .kicad_mod or .svg source file.
   • preview.svg or preview.png (recommended): the artwork only, in white/cream strokes on a transparent background, no board behind it. The gallery draws the green PCB for you. If you skip it, your first source SVG is shown as-is with a small info note.
   • photo.jpg / photo.png (optional): a photo of the art on a real manufactured board. If present, the gallery shows it instead of the rendered preview.

4. open the pull request

   Back on your fork's front page, hit Contribute → Open pull request, give it a title, and Create pull request. That sends your piece to us for review.

5. let the robot check it

   A validation check runs on every pull request automatically. A green tick means your folder is good; a red cross means something's off. Open the check's details and the log tells you exactly what to fix (a missing field, a file over the size limit, …). Just edit the files in your fork and the pull request re-checks itself.

6. merged = live

   Once a maintainer approves and merges, the gallery index rebuilds itself and your piece appears on this page within a few minutes. Your .kicad_mod also lands in the repo's robrotics-art.pretty/ KiCad library automatically.

Comfortable with git? git clone your fork, add art/<your-slug>/, run node scripts/build-index.js --check to validate locally, push, and open the pull request. Full details in the repo README.