README instructions for writing blog entries do not work as-is

Aperta Adatta ai principianti
#94 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
78/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Tranquilla
Stack tecnologico
bun
Ambito
documentation

Direzione di ricerca

Aggiorna le istruzioni del README per la scrittura degli articoli del blog. Verifica la configurazione documentata controllando il workflow make dev e make install, quindi indica che Bun è obbligatorio e che make install deve essere eseguito prima di make dev; il lavoro è completato quando un nuovo collaboratore può seguire le istruzioni senza riscontrare gli errori segnalati.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

The README currently says:

You can pull the repo, run make dev, and edit the page via Keystatic with the nice UI

I did so, and noticed that this had an implicit dependency on Bun. This dependency should be called out.

After installing Bun, I got a different failure due to the astro not being installed:

❯ make dev        
bun run dev
$ astro dev
/bin/bash: astro: command not found
error: script "dev" exited with code 127
make: *** [dev] Error 127

This is because, the user needs to do a make install before make dev.

I did end up writing it in Markdown, since I'm familiar with that.

Lingua principale
Astro
Stelle
32
Fork
12
Merge medio
9h 37m
PR unite (30g)
9

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di python/python-insider-blog

Tutte le issue di python/python-insider-blog

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.