Contribuer à FreeCAD

From FreeCAD Documentation
This page is a translated version of the page Help FreeCAD and the translation is 100% complete.

Introduction

Si vous aimez FreeCAD et souhaitez aider le projet, vous pouvez faire beaucoup de choses, que vous préfériez investir du temps ou de l'argent, ou que vous sachiez écrire du code ou non.

Don d'argent

Bien que FreeCAD n'ait pas besoin d'argent pour être développé, les dons peuvent aider le projet à se développer plus loin et plus rapidement. La page Faire un don liste toutes les options dont vous disposez pour donner de l'argent au projet.

Travailler sur la documentation

Aidez-nous à construire, corriger et étendre cette documentation. Corrigez les erreurs, étendez ou corrigez les pages qui ne sont pas claires, créez de nouvelles pages si un sujet est manquant, etc. Contribuer au wiki FreeCAD est facile, sur Les pages Wiki vous pouvez trouver les directives générales et l'aide nécessaire pour commencer. Pour éditer le wiki, vous aurez besoin d'un compte wiki avec les permissions "Éditeur" (le wiki est protégé en écriture pour éviter le spam). Vous pouvez demander un compte sur le forum ou sur le canal IRC . Veuillez noter que le canal IRC peut ne pas être aussi réactif que le forum. Le forum officiel de FreeCAD devrait être le premier endroit pour poser des questions et démarrer des discussions, car il aidera à préserver l'expérience et les connaissances de la communauté.

Quelques domaines qui apprécieraient votre contribution :

  • La liste des commandes de référence de toutes les commandes de FreeCAD. La plupart d'entre elles contiennent peu ou pas d'informations. Veuillez vous référer à Ecrire une page Wiki 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 tickets ouverts sur le "bug tracker" de FreeCAD étiquetés "documentation" qui auraient besoin d'un peu d'amour.

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 vidéos détaillant les étapes que vous avez franchies pour arriver à votre projet terminé dans FreeCAD. Ces vidéos sont une bonne façon de montrer de nouvelles fonctionnalités.
  • Écrire des tutoriels 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.
  • Publiez sur le réseau social open source Mastodon (et suivre FreeCAD ici), sur Facebook ou sur Twitter (et suivre FreeCAD ici). Utilisez les hashtags #FreeCAD, #MadeWithFreeCAD ou #fc3d pour que les autres utilisateurs de FreeCAD puissent trouver plus facilement vos messages relatifs à FreeCAD.
  • 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.

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.

Triage des bogues

Des dizaines de bogues sont signalés chaque semaine sur GitHub. Il faut beaucoup de temps pour les lire, les catégoriser, vérifier si le problème est reproductible, voir si des actions simples peuvent être réalisées ou demander à la personne qui a posté le problème de fournir plus d'informations. Il est facile d'aider au triage, il suffit de se rendre sur GitHub et de commencer à commenter tout problème pour lequel vous pensez pouvoir apporter votre aide !

Design graphique

Consultez les pages Graphisme et Recommandations pour la charte graphique pour connaître les directives sur la conception d'icônes pour FreeCAD.

Écrire du code

Écrire du code pour FreeCAD n'est pas difficile, et vous n'avez besoin d'aucune permission, vous pouvez commencer dès maintenant à travailler sur ce que vous voulez, puis soumettre un patch sur le gestionnaire de problèmes ou demander une fusion à partir d'une branche git. Pour éviter les maux de tête, vous devez d'abord remplir les conditions préalables suivantes :

  • Les informations comment compiler FreeCAD sont disponibles pour différents systèmes d'exploitation.
  • 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 qui est synchronisé avec notre canal gitter, 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 2020. Assurez-vous de vérifier vos idées à cet endroit si vous souhaitez participer à une prochaine édition.
  • De plus en plus de fonctionnalités de FreeCAD ne sont pas écrites dans le code FreeCAD lui-même mais dans des extensions et des macros. Ensemble, cet écosystème est ce qui rend FreeCAD puissant. Souvent, travailler sur une extension est plus facile parce qu'il y a moins de code à lire et à comprendre, et moins de personnes impliquées. Consultez le dépôt des extensions et le dépôt des Macros pour avoir quelques idées !

Créer des modèles

FreeCAD dispose d'une bibliothèque de modèles qui est gratuite et ouverte à tous. Pourquoi ne pas y ajouter des éléments utiles, qui pourraient être réutilisés par d'autres ? Veillez à créer vous-même des modèles à partir de rien, afin que la bibliothèque reste à 100% exempte de composants éventuellement protégés par des droits d'auteur ou non libres.