Guida alla Contribuzione per Bibliotecari

Ultimo Aggiornamento 27 aprile 2025

Guide

Guida alla Contribuzione per Bibliotecari

Modi per Contribuire

Attualmente stiamo cercando contributi nelle seguenti aree:

Documentazione API: Aiutaci a migliorare la documentazione API aggiungendo nuove pagine o aggiornando i contenuti esistenti.
Guide API: Condividi ciò che conosci scrivendo guide su come utilizzare l’API di Hardcover.
Correzione Bug: Aiutaci a correggere bug nel sito della documentazione.
Segnalazione Problemi: Segnala qualsiasi problema riscontrato con il sito della documentazione. Crea Issue
Richiesta Funzionalità: Condividi le tue idee per nuove funzionalità o miglioramenti al sito della documentazione. Suggerisci Funzionalità
Guide per Bibliotecari: Condividi le tue competenze scrivendo guide su come utilizzare gli strumenti per Bibliotecari.

Trovare Qualcosa su cui Lavorare

Per trovare problemi su cui lavorare puoi guardare la Bacheca degli Issues su GitHub o unirti al Discord di Hardcover e chiedendo suggerimenti nei canali #API o #librarians.

Essere un Buon Contributore

Quando contribuisci a Hardcover, segui queste linee guida:

Sii rispettoso degli altri e dei loro contributi.
Sii aperto al feedback e disposto a fare cambiamenti basati sul feedback.
Sii paziente e comprensivo riguardo al tempo necessario per revisionare e fare merge dei contributi.
Sii chiaro e conciso nei tuoi contributi.
Sii disposto ad aiutare gli altri e rispondere alle domande.
Sii disposto a lavorare con altri per migliorare il sito della documentazione.
Sii aperto all’apprendimento e alla crescita come contributore.
Sii disposto a seguire i processi di contribuzione.
Sii disposto ad accettare che non tutti i contributi saranno accettati.

Come aggiungo una nuova pagina o aggiorno una pagina esistente?

Aggiungere una Nuova Pagina

Naviga alla pagina GitHub della Documentazione di Hardcover
Naviga alla directory src/content/docs/.
Naviga alla sottodirectory della pagina che vuoi aggiungere.
Clicca sul pulsante “Add file” nella parte superiore destra dell’elenco dei file.
Clicca sull’opzione “Create new file”.
Nell’editor che si apre, dai al nuovo file un nome significativo che termini con .mdx, controlla i file esistenti per vedere degli esempi.
Aggiungi il frontmatter alla nuova pagina utilizzando il template sottostante.
Fornisci il contenuto per la nuova pagina utilizzando la sintassi Markdown o MDX.
Visualizza un’anteprima delle tue modifiche per verificare formattazione e accuratezza.
Clicca sul pulsante “Commit changes…” nella parte superiore della pagina.
Nella finestra di dialogo che si apre, fornisci un titolo e una descrizione per le tue modifiche.
Assicurati che l’opzione “Create a new branch for this commit and start a pull request” sia selezionata.
Dai al tuo branch un nome breve e descrittivo.
Clicca sul pulsante “Propose changes” per salvare le tue modifiche.
Notifica il team di Hardcover, in particolare @revelry nel Discord di Hardcover comunicando che hai inviato una pull request.
Attendi una revisione e feedback dal team di Hardcover.
Apporta eventuali modifiche richieste.
Una volta che la tua pull request è approvata, sarà unita al branch principale.
Festeggia il tuo contributo!
Continua a contribuire a Hardcover!

Modificare una Pagina Esistente

Utilizzando l’interfaccia utente, naviga alla pagina che desideri modificare.
Clicca sul pulsante “Modifica paigina” nella parte inferiore del contenuto.
Nella pagina GitHub che si apre, clicca sull’icona della matita nella parte superiore destra del file per iniziare a modificare.
Apporta le tue modifiche nell’editor utilizzando la sintassi Markdown o MDX.
Aggiorna il frontmatter utilizzando il modello sottostante, assicurati di aggiornare il campo lastUpdated.
Visualizza un’anteprima delle tue modifiche per verificare formattazione e accuratezza.
Clicca sul pulsante “Commit changes…” nella parte superiore della pagina.
Nella finestra di dialogo che si apre, fornisci un titolo e una descrizione per le tue modifiche.
Assicurati che l’opzione “Create a new branch for this commit and start a pull request” sia selezionata.
Dai al tuo branch un nome breve e descrittivo.
Clicca sul pulsante “Propose changes” per salvare le tue modifiche.
Notifica il team di Hardcover, in particolare @revelry nel Discord di Hardcover comunicando che hai inviato una pull request.
Attendi la revisione e feedback dal team di Hardcover.
Apporta eventuali modifiche richieste.
Una volta che la tua pull request è approvata, sarà unita al branch principale.
Festeggia il tuo contributo!
Continua a contribuire a Hardcover!

Aggiungere Immagini

Attualmente, le immagini devono essere aggiunte tramite una pull request separata. Per aggiungere un’immagine:

Naviga alla pagine GitHub della Documentazione di Hardcover
Naviga alla directory public/images/.
Naviga alla sottodirectory api o librarians a seconda di dove verrà utilizzata l’immagine.
Clicca sul pulsante “Add file” nella parte superiore destra dell’elenco dei file.
Clicca sull’opzione “Upload files”.
Trascina e rilascia i file immagine nell’area di caricamento.
Nella sezione Commit changes, fornisci un titolo e una descrizione per le tue modifiche.
Assicurati che l’opzione “Create a new branch for this commit and start a pull request” sia selezionata.
Dai al tuo branch un nome breve e descrittivo.
Clicca sul pulsante “Propose changes” per salvare le tue modifiche.
Notifica il team di Hardcover, in particolare @revelry nel Discord di Hardcover comunicando che hai inviato una pull request.
Attendi la revisione e feedback dal team di Hardcover.
Apporta eventuali modifiche richieste.
Una volta che la tua pull request è approvata, sarà unita al branch principale.
Dopo che l’immagine è stata unita, segui i passaggi nella sezione Modificare una Pagina Esistente per aggiungere l’immagine e farvi riferimento utilizzando il percorso relativo: /images/subdirectory/your-image.png.

<img src="/images/librarians/long-title-example.png" alt="Esempio di un titolo lungo su Hardcover" />

Page Frontmatter

Spostato in Frontmatter

Componenti Disponibili

Spostato in Astro Components per i componenti Astro e React Components per i componenti React.

Supporto per le Traduzioni

Sebbene attualmente supportiamo solo l’inglese, siamo aperti ad aggiungere traduzioni in futuro. Se sei interessato a contribuire con traduzioni, contatta il team di Hardcover nei canali #API o #librarians sul Discord di Hardcover.

Risorse di Supporto

Trovare Aiuto su Discord

Connettiti con noi su Discord