Submit a project

Community projects live in this site’s repository, one per folder. You send yours as a GitHub pull request (PR) and it shows up on the site after review. You can do it all from the browser, without installing Git.

What you can send

Type	Examples	Accepted licenses
`case`	case variant, keycaps, stand	CC-BY-4.0, CC-BY-SA-4.0, CERN-OHL-S-2.0
`perfil` (profile)	profile exported from the app (OBS, Photoshop, games…)	CC0-1.0, CC-BY-4.0
`build`	“here is how I built mine”: photos, parts, changes	CC-BY-4.0, CC-BY-SA-4.0, CERN-OHL-S-2.0
`firmware`	modified firmware	GPL-3.0-or-later

The Polpad firmware is GPL, so modified firmware must be GPL too and must include its source code or a link to it.

Step by step

Open the site repository and click Fork.
In your fork, go into the comunidade folder and click Add file → Create new file.
In the name field, type your project’s folder name, a slash and projeto.yml, for example acrylic-top-case/projeto.yml. Typing the slash makes GitHub create the folder. Use only lowercase letters, numbers and hyphens in the folder name.
Paste the projeto.yml content (template below), fill it in and click Commit changes.
Go into the folder you created, click Add file → Upload files and upload the cover image, photos and project files. Click Commit changes again.
Go back to your fork’s page and click Contribute → Open pull request.
An automatic check looks at your submission. If it turns red, click Details to see the file and the reason.
After review, the project shows up on the site.

The projeto.yml file

The field names are in Portuguese; keep them as they are.

titulo: Acrylic top case           # title
tipo: case                         # case | perfil | build | firmware
autor:                             # author
  nome: Your name
  github: your-username             # optional
descricao: |                       # description
  A short text about the project.

  Blank lines separate paragraphs.
licenca: CC-BY-4.0                 # license, one accepted for the type
data: 2026-11-07                   # date
capa: cover.jpg                    # cover image
fotos: [photo1.jpg, photo2.jpg]    # optional: photos
arquivos:                          # optional: files inside the folder
  - files/top.stl
links:                             # optional: large or external files
  - titulo: Printables
    url: https://www.printables.com/...
versao_firmware: 2.1.0             # optional: firmware version tested

Limits

Each image up to 1 MB.
The whole folder up to 25 MB. For bigger files, use links (Printables, Thingiverse, a release on your GitHub…).
Up to 30 files per project.
Accepted extensions: .yml .md .jpg .jpeg .png .webp .stl .3mf .step .json .bin. No .zip: send the files themselves. .bin only in firmware projects.
The content must match the extension: a file renamed to .png that is not an image is rejected.
One project per PR, and the PR may only touch your project’s folder.

See the source in the repository ↗