Contribuer à FreeCAD

From FreeCAD Documentation
Revision as of 11:54, 19 December 2019 by Gnrc (talk | contribs) (Created page with "Traduire le wiki est facile, le wiki FreeCAD intègre un plugin de traduction qui vous permet de traduire la page anglaise de base dans d’autres langues.")

Si vous aimez FreeCAD et que vous désirez participer à son développement, en dehors d'une donation directe, il y a beaucoup d'autres choses que vous pouvez faire, même si vous n'êtes pas un programmeur.

Travailler sur la documentation

Aidez-nous à construire, à rectifier et étendre cette documentation. Vous pouvez corriger les erreurs, documenter ou corriger les pages qui ne sont pas claires, créer de nouvelles pages si un sujet est manquant, etc. Contribuer au wiki FreeCAD est facile, vous pourrez trouver sur la page WikiPages (traduction française manquante) les recommandations générales ainsi que l'aide nécessaire pour débuter. Pour modifier le wiki, un compte "Éditeur" est nécessaire (le wiki est protégé en écriture afin d'éviter le spam). Vous pouvez demander un compte sur le forum ou sur le canal IRC. Notez que le canal IRC n'est pas forcement aussi actif que le forum.

Quelques zones qui apprécieraient votre contribution :

  • La catégorie Command Reference liste toutes les commandes FreeCAD. La plupart d'entre elles contiennent peu ou pas d'informations. Veuillez vous référer à WikiPages (en) pour des recommandations de ce que devrait être une bonne page de documentation de commandes.
  • La section tutoriels a besoin d'exemples d'utilisation des ateliers. Si vous avez développé quelque chose de sympa avec FreeCAD, pourquoi ne pas le pérenniser dans une page de documentation ?
  • Il y a des billets ouverts sur le bugtracker de FreeCAD intitulé "documentation" qui mériteraient qu'on s'y intéresse.

Partagez vos connaissances de FreeCAD

La communauté des utilisateurs de FreeCAD est encore faible, mais comprend plusieurs utilisateurs éclairés, qui fournissent un travail très important, pour montrer et apprendre aux nouveaux arrivants comment utiliser le logiciel. Si vous commencez à vous sentir à l'aise avec FreeCAD, vos connaissances pourraient être très utiles à d'autres, et vous pourriez contribuer, grâce à vos acquis, à :

  • Montrer ce que vous avez réalisé sous FreeCAD sur le forum Users Showcase. Vous pouvez poster des captures d'écran, mieux encore, joindre vos fichiers FreeCAD pour que d'autres personnes puissent les examiner et comprendre comment vous avez travaillé et découvrir d'autres fonctionnalités.
  • Enregistrer des clips vidéos détaillant les étapes que vous avez franchies pour arriver à votre projet final, dans FreeCAD. Ces vidéos sont une bonne façon de montrer de nouvelles fonctionnalités.
  • Écrire des didacticiels décrivant ou enseignant quelque chose d'intéressant. Vous pouvez écrire des tutoriels sur votre propre blog, directement sur ​​notre wiki, ou même sur le forum.
  • Poster sur le réseau social libre Mastodon (et suivez-y [1]) ou sur la communauté Facebook.
  • Consultez les dernières publications de FreeCAD sur Reddit, 3dprinting.stackexchange, StackOverflow... Essayez d'y répondre et de participer aux discussions en partageant votre expérience et vos informations.
  • Être présent sur le canal IRC FreeCAD ou d'autres groupes de discussion.

Traduire FreeCAD

Traduire FreeCAD dans votre propre langue. Tout le texte de l'interface de FreeCAD peut être facilement traduit dans d'autres langues. Nous avons juste besoin de quelqu'un qui connaisse cette langue, et qui soit prêt à aider ! Toutes les traductions sont faites en ligne sur Crowdin.

Pour plus d'informations sur la traduction, voir la méthodologie de Localisation.

Traduire la documentation

Traduire le wiki est facile, le wiki FreeCAD intègre un plugin de traduction qui vous permet de traduire la page anglaise de base dans d’autres langues.

Pour plus d'informations sur la traduction, voir la section Traduire la documentation de FreeCAD.

Assurez-vous d'être familier avec les bases du balisage wiki. voir Aide pour l'édition pour plus d'informations.

Rendez-vous ensuite sur WikiPages pour vous familiariser avec le style utilisé dans ce wiki, notamment en ce qui concerne les modèles.

Faites connaître FreeCAD

  • Parlez de FreeCAD à ceux qui pourraient être intéressés.
  • Trouvez des utilisations intéressantes pour FreeCAD, et documentez les, par exemple avec des captures d'écran. FreeCAD est très jeune, et beaucoup de gens ne savent pas ce qu'ils peuvent faire avec. Si vous êtes déjà fan de FreeCAD, vous savez sûrement faire des choses sympa avec FreeCAD. Aidez-nous à les faire connaître aux autres !
  • Postez sur le forum, et aidez les nouveaux arrivants, en répondant à leurs interrogations courantes.
  • Écrivez des didacticiels, enregistrez des vidéos, etc., montrant ce que vous faites avec FreeCAD.
  • Contribuez avec des fichiers, dessins, etc. Nous manquons encore de bons exemples de projets qui seraient réalisables avec FreeCAD.
  • Aidez à promouvoir FreeCAD sur GitHub, en affichant et en mettant en avant le dépôt FreeCAD.
  • 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

Rapporter les bogues et demander des fonctionnalités intéressantes

L'endroit pour rapporter les bogues et suggérer de nouvelles fonctionnalités est le FreeCAD Tracker. Merci de toujours poster d'abord les rapports de bugs et les demandes de fonctionnalités sur le forum d'aide. Afin de faire gagner du temps aux développeurs (le tri et la gestion des bogues difficiles à comprendre peut prendre beaucoup de temps) et d'éviter les frustrations si votre problème n'a pas été traité comme vous l'auriez souhaité, veuillez lire ce qui suit :

  • Les bogues et requêtes de fonctionnalités sont traités par le même tracker.

Vous devez simplement marquer votre problème comme "Bug" (quelque chose qui ne fonctionne pas comme il le devrait) ou comme "Feature" (une fonctionnalité qui n'est pas présente, mais que vous pensez qu'il serait intéressant d'avoir).

  • Bien qu'à l'origine vous ayez pu soumettre des questions anonymement, cette pratique a du être abandonnée pour cause de spam. Actuellement si vous désirez créer/éditer des billets, vous devez vous créer un compte sur (sourceforge). Vous serez alors averti, lorsque quelqu'un ajoutera des notes à la question. Dans bien des cas, la personne qui s'occupera du bogue aura besoin d'autres informations de votre part.
  • Lorsque vous signalez un bogue, la chose la plus importante, est de permettre aux développeurs de le reproduire. N'oubliez pas d'inclure les étapes exactes nécessaires pour que le bug se produise, afin qu'une autre personne puisse le reproduire sur sa machine. Si le développeur n'arrive pas voir le bogue, il ne peut pas non plus le résoudre.
  • Incluez aussi les informations pouvant aider les développeurs à situer le problème, tel le système d'exploitation sur lequel vous exécutez FreeCAD, la version de exacte de FreeCAD et les bibliothèques correspondantes. Transmettez toutes les données du menu Aide → À propos de FreeCAD, en utilisant le bouton Copier dans le presse-papier ; faites cela à partir de l'atelier Part ou PartDesign.
  • Même si vous êtes certain d'avoir trouvé un bogue, veuillez toujours en discuter en premier dans le forum d'aide.
  • Avant de soumettre une demande de fonctionnalité, discutez-en toujours avec les autres utilisateurs sur le forum discussions ouvertes, de sorte que vous puissiez vous retrouver avec une proposition plus solide, ayant plus de chances d'intéresser un programmeur à la mettre en œuvre.
  • Rappelez-vous que FreeCAD est développé par des bénévoles qui utilisent leur temps libre pour travailler à son élaboration. Bien que tous essaient de leur mieux de développer la meilleure application possible, votre rapport de bogue pourrait être traité avec une faible priorité, ou abandonné si vous ne pouvez pas fournir suffisamment d'informations. Votre demande de fonctionnalité pourrait être reportée ou même abandonnée si aucun développeur ne souhaite la mettre en œuvre, ou si elle demande une quantité de travail beaucoup trop importante.

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.

Graphisme

Consultez la page Graphisme pour connaître les directives sur la conception d'icônes pour FreeCAD.

See the Artwork and Artwork Guidelinespage for guidelines about designing icons for FreeCAD.

Programmer !

L'écriture de code pour FreeCAD n'est pas difficile, et vous n'avez besoin d'aucune autorisation pour cela. Vous pouvez commencer dès maintenant à travailler sur quelque chose dont vous avez besoin, et le soumettre comme patch via le tracker, ou demander son intégration à partir d'une branche Git. Pour éviter les maux de tête, vous devrez d'abord accepter les prérequis suivants :

  • FreeCAD avance à son propre rythme, et dispose d'une très petite équipe de développeurs. Nous n'avons pas tout le temps que nous aimerions consacrer à FreeCAD, et rien n'est planifié à l'avance. Le travail se fait quand un développeur trouve le temps de le faire et qu'il juge cela utile. Nous ne maintenons pas de liste des tâches à accomplir. C'est à chacun de trouver ce qu'il aimerait traiter, par exemple un bug que vous voudriez corriger, ou une petite fonctionnalité que vous pensez manquante. Le tracker contient également certains sujets qui ne sont attribués à personne, et qui attendent un volontaire.
  • Avant de commencer à coder pour FreeCAD, vous devez bien connaître sa façon de fonctionner. Cela semble évident, mais si vous ne savez pas comment il est censé fonctionner, vous ne saurez pas quoi faire en interne, ni comment le faire.
  • Presque tout peut être fait en Python ou en C++. Les tâches internes fonctionnent presque de la même façon dans les deux langages. Nous vous conseillons de lire la page Documentation pour utilisateurs avancés, même si vous comptez programmer en C++, car cela vous donnera un bon aperçu de ce fonctionnement internes.
  • Si vous comptez travailler en C++, assurez-vous avant tout de pouvoir compiler FreeCAD sans problème.
  • Présentez-vous aux autres développeurs. FreeCAD est avant tout un projet social, nous discutons de beaucoup de choses sur le forum avant leur mise en œuvre, et il est toujours préférable de discuter de vos idées et dire aux autres ce que vous envisagez de faire avant de le concrétiser. Nous avons également un canal IRC, mais le forum est le seul et unique endroit de rencontre de tous les développeurs.
  • Depuis 2016, FreeCAD participe également au Google Summer of Code. Assurez-vous de vérifier vos idées à cet endroit si vous souhaitez participer à une prochaine édition.

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.