Skip to content

YC (S26) | Open Computer History | Continuously record your company computer work, map your workflows, help you find work worth automating, and power your agents' context

docs(contributing): fix PR-media guidance — forks can't upload to upstream releases

Louis Beaumontd310471a57a6
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 30b93fe1b..15bcce189 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -13,7 +13,7 @@ brief description of the changes in this pr.
related issue: #
-> attach screenshots / recordings here — **never commit media into the repo.** agents/cli: `gh release upload <tag> file.png` (or `gh gist create file.png`) and paste the url. humans: just drag the file into this box — github hosts it.
+> attach screenshots / recordings here — **never commit media into the repo.** drag the file into this box (works for anyone, browser only) and github hosts it. on the cli: attach it as a release asset — `gh release upload <tag> file.png` if you can write here, else `gh release create media file.png --repo <you>/screenpipe` on your fork — and paste the url.
## before
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 2d569a9e3..6db2879b1 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -158,8 +158,8 @@ this section guides you through submitting an enhancement suggestion for screen
- fill in the required template
- do not include issue numbers in the pr title
- include screenshots and animated gifs in your pull request whenever possible — but **never commit media files** to the repo (no screenshots, mockups, or recordings under `docs/`, `.github/`, or the repo root; they bloat git history and are never referenced by the code). host them on github and paste the url into the pr body:
- - **agents / cli** (drag-drop is browser-only, so `gh` can't do it): `gh release upload <tag> shot.png` against a throwaway/`assets` release → link `https://github.com/screenpipe/screenpipe/releases/download/<tag>/shot.png`; or `gh gist create shot.png` and link its raw url. both render inline in markdown.
- - **humans:** drag the file straight into the pr description — github hosts it as a `https://github.com/user-attachments/...` link.
+ - **drag-drop (anyone, browser only):** drop the file into the pr description — github hosts it as a `https://github.com/user-attachments/...` link. needs no repo access, so this is the path for fork-based contributors.
+ - **cli / agents (can't drag-drop):** attach the file as a release asset and link the url — images render inline whatever repo hosts them. maintainers with write access here: `gh release upload <tag> shot.png` (use a throwaway/`assets` release). from a fork: `gh release create media shot.png --repo <you>/screenpipe`, then link `https://github.com/<you>/screenpipe/releases/download/media/shot.png`. any external image host works too.
- follow the rust styleguides.
- end all files with a newline.