Contribuire

From FreeCAD Documentation
Revision as of 16:34, 22 February 2020 by FuzzyBot (talk | contribs) (Updating to match new version of source page)
Jump to navigation Jump to search
Other languages:
Deutsch • ‎English • ‎Türkçe • ‎español • ‎français • ‎hrvatski • ‎italiano • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎svenska • ‎čeština • ‎български • ‎русский • ‎українська • ‎中文(中国大陆)‎ • ‎中文(台灣)‎ • ‎日本語 • ‎한국어

Introduction

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.

Help us to build, correct and extend this documentation. Correct mistakes, extend or correct pages that are unclear, create new pages if a topic is missing, etc. Contributing to the FreeCAD wiki is easy, at WikiPages you can find the general guidelines and the help needed to get you started. To edit the wiki, you will need a wiki account with "Editor" permissions (the wiki is write-protected to avoid spamming). You can ask for an account on the forum or on the IRC channel. Please note that the IRC channel may not be as responsive as the 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

The user community around FreeCAD is still small, but already includes several advanced users who do a very important job in showing to newcomers how to use the software. If you begin to feel comfortable with FreeCAD, your knowledge could be very valuable to others, and you might contribute with important assets, like:

  • Showing the work you do with FreeCAD on the Users Showcase forum. You can post screenshots, and, even better, attach the FreeCAD files so other people can examine it and understand how you did it.
  • Recording videos showing how you did something interesting in FreeCAD. These videos usually do a great job in showing new features.
  • Write tutorials describing or teaching something interesting. You can write tutorials on your own blog, directly on our wiki, or even on the forum.
  • Post on the Mastodon open source social network (and follow FreeCAD there) or on the Facebook community.
  • Look into the latest FreeCAD posts on Reddit, 3dprinting.stackexchange, StackOverflow... Try to answer them and participate in the discussions sharing your experience and information.
  • Be present at the FreeCAD IRC channel or other chat groups

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.

Translate FreeCAD to your own language. All text strings of the FreeCAD interface can be easily translated to other languages. All we need is someone who knows that other languages and is willing to help! All the translations are done online on 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.

Translating is easy, the FreeCAD wiki supports a translation plugin which allows you to translate the base English page to other languages.

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
  • Talk about FreeCAD to other people who might be interested
  • Find interesting uses for FreeCAD, and document it, for example with screenshots. FreeCAD is very young, and not many people see what they can do with it. If you are a FreeCAD fan already, you surely know some cool thing FreeCAD can do. Help us to show that to others!
  • Hang on the forum, and help newcomers to solve basic questions
  • Write tutorials, record videos, etc., showing what you do with FreeCAD
  • Contribute with files, drawings, etc. We still lack good example files of what can be done with FreeCAD
  • Help to promote FreeCAD on GitHub by "Starring" and "Watching" the FreeCAD repository

Segnalare Bug e suggerire nuove funzionalità

Bugreport-workflow.png

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.
Bugreport-workflow.png

Although the place to report confirmed bugs and suggest new features is eventually the FreeCAD Tracker, please always post bug reports and feature requests to the Help forum first. In order to save developers time (triaging and handling hard to understand bugs can be very time consuming), and avoid frustrations because your issue was not handled the way you would like, please read the following:

  • Bugs and features requests are handled in the same tracker. Just mark your issue as "bug" (something that doesn't work as it should) or "feature" (something that is not there but you think it would be good to have)
  • Although originally you could submit issues anonymously, unfortunately this had to be cancelled due to spam. Now if you would like to create/edit tickets you will have to create an account. You will then by default be notified when someone adds notes to the issue. In many cases, the person who will handle the bug will need more information from you.
  • When reporting a bug, the most important point is to allow developers to reproduce it. Be sure to include the exact steps needed to make the bug happen, so another person can do the same and see the bug happen on his machine too. If the developer cannot see the bug, he cannot solve it either.
  • Also include information that can help developers to situate the problem, like the operating system you are running FreeCAD on, the exact version of FreeCAD and the relevant libraries. Please post all the data by using the "copy to clip board" button in the Help (menu) → about FreeCAD dialogue, and do this from the Part or PartDesign workbench.
  • No matter how sure you are that you have found a bug, please always discuss bugs first in the Help forum.
  • Before submitting a feature request, always discuss it with other users first on the Open discussion forum, so you might end up with a more solid proposal, with more chances to interest a developer to implement it.
  • Remember that FreeCAD is developed by volunteers who use their free time to work on it. Although everyone tries his best to make the best possible application, your bug report might be treated with low priority, or canceled if you cannot give sufficient information, and your feature request might be postponed or even refused if no developer has interest in implement it or if that would request an unrealistic amount of work.

Grafica

Per le linee guida sulla progettazione delle icone per FreeCAD consultare la pagina Artwork.

See the Artwork and Artwork Guidelines page for guidelines about designing icons for FreeCAD.

Programmare!

Scrivere del codice per FreeCAD non è difficile, e non serve alcuna autorizzazione, è possibile iniziare subito a lavorare su quello che si desidera, poi presentare una patch oppure richiedere la sua fusione (merge) con un ramo git. Ma per evitare dei problemi si dovrebbe prima soddisfare i seguenti prerequisiti:

  • FreeCAD evolve con il proprio ritmo, e ha un team di sviluppatori molto esiguo. Non abbiamo tutto il tempo che vorremmo dedicare a FreeCAD, e le cose non sono pianificate in anticipo, sono fatte quando qualche sviluppatore le ritiene idonee e quando trova il tempo per farle. Quindi noi non manteniamo un elenco di attività da fare. Spetta all'utente di trovare qualcosa che gli piacerebbe fare, ad esempio, un difetto che desidera correggere, o una piccola funzione che ritiene essere mancante. Il tracker contiene anche alcuni elementi che non sono ancora stati assegnati a nessuno.
  • Prima di iniziare a scrivere del codice per FreeCAD, è necessario conoscere bene come funziona FreeCAD. Questo sembra ovvio, ma quando non si sa come deve funzionare, non si sa cosa fare o come fare.
  • Quasi tutto può essere fatto sia in Python o C++. I programmatori lavorano quasi nello stesso modo in entrambi i linguaggi. Anche se avete intenzione di lavorare in codice C++, vi consigliamo di leggere le pagine dedicate agli utenti avanzati, perché danno una buona panoramica di come funziona FreeCAD.
  • Se avete intenzione di lavorare in C++, prima accertatevi che sia possibile compilare FreeCAD senza problemi.
  • Presentarsi agli altri sviluppatori. FreeCAD è prima di tutto un progetto sociale. Nel forum si discute di un sacco di cose prima di implementarle, ed è sempre meglio discutere le proprie idee e dire agli altri cosa si ha intenzione di fare prima di farlo veramente. Abbiamo anche un canale IRC, ma il forum è l'unico luogo dove si possono incontrare tutti gli sviluppatori.
  • Dal 2016, FreeCAD partecipa anche al Google Summer of Code. Se siete interessati a partecipare ad una prossima edizione, controllate in tale pagina quali sono le nostre idee.

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.