Contribuire

From FreeCAD Documentation
Revision as of 08:19, 19 September 2020 by Renatorivo (talk | contribs) (Replaced content with "== Programmare! ==")

Introduzione

Se FreeCAD piace e si vuole contribuire al suo sviluppo, oltre ad una donazione, si possono fare molte cose, anche senza essere programmatori.

Migliorare la documentazione

Si può, ad esempio, aiutare a migliorare la documentazione del programma, correggere ed estendere i capitoli esistenti oppure creare delle nuove pagine per spiegare l'utilizzo di una determinata funzione del programma che non è ancora spiegata in nessuna altra pagina. Contribuire al wiki di FreeCAD è facile, la pagina Editing spiega come iniziare e nella sezione WikiPages si trovano le regole da seguire. Per lavorare sulla documentazione è necessario richiedere un account con i permessi di "Editor" tramite il forum oppure attraverso il canale IRC il permesso di editare il wiki che è protetto in scrittura per prevenire lo spamming. Notare che il canale IRC potrebbe non essere così reattivo come il forum.

Alcune aree che devono essere ampliate e migliorate sono:

  • La sezione Guida ai comandi, in inglese la Category:Command Reference, che include tutti i comandi utilizzabili in FreeCAD, ma molti di questi non hanno ancora una descrizione oppure, se esiste, è molto scarna. Fare riferimento a WikiPages per vedere dei validi esempi su come costruire delle adeguate descrizioni.
  • La sezione dei Tutorial ha bisogno di esempi su come usare gli ambienti. Se avete sviluppato o realizzato qualcosa di interessante con FreeCAD potete fare qualcosa di molto utile se scrivete una guida e la pubblicate in questo capitolo della documentazione.
  • Nel bugtracker di FreeCAD ci sono delle etichette aperte contrassegnate 'documentation' che meritano attenzione.

Condividere le conoscenze su FreeCAD

La comunità degli utenti di FreeCAD è ancora piccola, ma comprende già diversi utenti avanzati che fanno un lavoro molto importante nel mostrare ai nuovi arrivati ​​come utilizzare il software. Le conoscenze di chi inizia a sentirsi a proprio agio con FreeCAD possono essere molto utili per gli altri, e permettono di contribuire con importanti attività, quali:

  • Mostrare il lavoro svolto con FreeCAD nella sezione del Users Showcase del forum. Pubblicare delle schermate, o, meglio ancora, allegare anche i file di FreeCAD in modo che gli altri utenti possano esaminarli e capire come è stato realizzato il lavoro.
  • Registrare dei video per mostrare il procedimento utilizzato per creare qualcosa di interessante con FreeCAD. I video di solito sono molto utili per descrivere le nuove funzionalità.
  • Scrivere dei tutorial per descrivere o insegnare qualcosa di utile. È possibile scrivere dei tutorial su un proprio blog, direttamente sul nostro wiki o anche nel forum.
  • Pubblicare sul social network open source Mastodon (and follow FreeCAD there) o nella community Facebook.
  • Guardare gli ultimi post di FreeCAD su Reddit, 3dprinting.stackexchange, StackOverflow ... Provare a rispondere ed a partecipare alle discussioni condividendo la propria esperienza e informazioni.
  • Essere presenti sul canale IRC di FreeCAD o altri gruppi di chat

Tradurre FreeCAD

Si può tradurre FreeCAD nella propria lingua. Tutte le stringhe di testo del programma possono essere facilmente tradotte. Serve qualcuno che conosca delle altre lingue e che sia disponibile a dare un aiuto! Tutte le traduzioni vengono effettuate on-line in Crowdin.

Per i dettagli sulla traduzione, vedere la pagina Localizzazione

Tradurre la documentazione

Tradurre questo wiki della documentazione è facile, il wiki di FreeCAD supporta un plugin traduzione che consente di tradurre la pagina inglese di base in altre lingue.

Per la traduzione in italiano si può anche fare riferimento a questo post.

Per i dettagli sulla traduzione, vedere il paragrafo Tradurre il wiki

Accertarsi di avere familiarità con le basi del markup wiki; vedere Help Editing come riferimento.

Quindi vedere la WikiPages per familiarizzare con lo stile utilizzato in questo wiki, in particolare quando si tratta di modelli.

Divulgare FreeCAD

  • Si può parlare di FreeCAD a amici e colleghi.
  • Trovare utilizzi interessanti e "non convenzionali" del programma e documentarli, ed esempio con l'utilizzo degli screenshots. FreeCAD è ancora molto giovane è non tutti sono in grado di capire a prima vista gli scopi per cui può essere utilizzato. Un'immagine vale più di mille parole.
  • Frequentare il forum ed aiutare i nuovi utenti con le operazioni di base.
  • Scrivere dei tutorial, registrare dei video, mostrare cosa si può fare con FreeCAD.
  • Contribuire con i propri disegni, schizzi, ecc. Contribuire con file, disegni, ecc. Mancano ancora file di esempio validi su cosa può essere fatto con FreeCAD.
  • Contribuire a promuovere FreeCAD su GitHub con "Starring" and "Watching" the FreeCAD repository

Segnalare i bug e suggerire nuove funzioni

Anche se il posto giusto per segnalare i bug confermati e suggerire delle nuove funzionalità è infine il FreeCAD Tracker, si prega di inviare sempre prima le segnalazioni di bug e le richieste di nuove funzionalità al Forum degli Help. Per far risparmiare tempo agli sviluppatori (la classificazione, manipolazione e comprensione dei bug possono richiedere molto tempo), e per evitare frustrazioni perché il problema non viene gestito nel modo che si desidera, si prega di leggere quanto segue:

  • I bugs e le richieste di caratteristiche (feature) vengono gestiti nello stesso tracker. Basta marcare come "bug" qualcosa che non funziona come dovrebbe oppure come "feature" qualcosa che non c'è, ma si pensa che sarebbe bene avere.
  • Anche se in origine era possibile presentare le istanze in forma anonima, purtroppo questo ha dovuto essere annullato a causa di spam. Ora, se si desidera creare o modificare le istanze si deve creare un account. Sarete quindi avvisati automaticamente quando qualcuno aggiunge delle note al problema. In molti casi, chi gestisce il bug ha bisogno di maggiori informazioni.
  • Nel riportare un bug, il punto più importante è quello di consentire agli sviluppatori di riprodurlo. Accertarsi di includere i passaggi esatti necessari per produrre il bug, in modo che altri possano fare la stessa cosa e riprodurlo anche sulla propria macchina. Se lo sviluppatore non può vedere il bug non può risolverlo.
  • Allegare anche le informazioni che possono aiutare gli sviluppatori a situare il problema, quali il sistema operativo su cui FreeCAD viene eseguito, l'esatta versione di FreeCAD utilizzata e le librerie relative. Si prega di inviare tutti i dati usando la funzione del pulsante "copia negli appunti" nel menu Aiuto → A proposito di FreeCAD, e di fare questo da entrambi gli ambienti Parte e PartDesign.
  • Non importa quanto si è sicuri di aver trovato un bug, discutere sempre i bug prima nel Help forum.
  • Prima di avanzare una richiesta di funzionalità discuterne sempre con gli altri utenti nel Open discussion forum, così si può presentare una proposta più circostanziata, con più possibilità che uno sviluppatore si interessi alla sua attuazione.
  • Ricordare che FreeCAD è sviluppato da dei volontari che usano il loro tempo libero per elaborarlo. Anche se tutti fanno del proprio meglio per costruire la migliore applicazione possibile, la segnalazione può essere trattata con priorità bassa, o annullata se non si danno informazioni sufficienti, e la richiesta di funzionalità potrebbe essere posticipata o addirittura rifiutata se nessun sviluppatore è interessato ad attuarla o se essa richiede una quantità esagerata di lavoro.

Grafica

Per le linee guida sulla progettazione delle icone per FreeCAD consultare la pagina Artwork e Linee guida per le opere grafiche.

Programmare!

Writing code for FreeCAD is not hard, and you don't need any permission, you can start right now to work on something you want, then submit a patch on the tracker or request a merge from a git branch. To avoid headaches you should meet the following prerequisites first:

  • FreeCAD goes at its own pace and has a very small team of developers. We have not as much time as we would like to dedicate to FreeCAD, and things are not planned ahead; they are done when some developer sees it fit and when he finds time to do it. So we don't maintain a list of tasks to be done. It is up to you to find something you would like to do, for example, a defect you would like to correct, or a small feature you think is missing. The tracker also contains some items that are not yet assigned to anybody.
  • Before you start to code for FreeCAD, you must know well how FreeCAD works. This seems obvious, but if you don't know how it is supposed to work you won't know what to do internally or how to do it.
  • Almost everything can be done either in Python or C++. The internals work almost the same in both languages. We suggest you read through the Power users hub pages, even if you're going to code in C++ since it will give you a good overview of the internals.
  • If you are going to work in C++, make sure you can compile FreeCAD without problems first.
  • Present yourself to other developers. FreeCAD is before anything a social project, we discuss a lot of things on the forum before implementing it, and it's always best to discuss your ideas and tell people what you are planning to do before actually doing it. We also have an IRC channel, but the forum is the one and only place where you can meet all the developers.
  • Since 2016, FreeCAD also participates in the Google Summer of Code. Be sure to check our ideas there if you are interested in participating in the next edition.