Contribuer à FreeCAD

From FreeCAD Documentation
Revision as of 08:13, 2 September 2017 by FabArd (talk | contribs)

Bonjour et bienvenue sur la page de participation.

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

En fait, il y a du travail ou passe-temps pour tout le monde : les curieux, les artistes, les utilisateurs, et les développeurs.

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 règles du wiki FreeCAD ainsi que l'aide nécessaire pour débuter. Pour éditer le wiki, un compte 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 accueillent votre travail :

  • La page Liste des commandes liste toutes les commandes FreeCAD. La plupart d'entre elles ont beaucoup d'informations, peu d'informations, aucune information ou tout simplement la page est inexistante. Veuillez vous référer à WikiPages pour des exemples de bonnes pages de documentation.
  • La section tutoriels est encore très pauvre. Si vous avez développé quelque chose de cool avec FreeCAD, pourquoi ne pas écrire comment vous avez fait?

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 dans l'utilisation de FreeCAD, vos connaissances pourraient être très utile à d'autres, et vous pourriez contribuer avec des atouts importants, comme :

  • 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.

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 connaît la langue, et qui est prêt à se mettre au travail pour nous aider ! Toutes les traductions sont faites en ligne sur Crowdin.

Pour plus d'informations sur la traduction, consultez le processus de traduction du Wiki FreeCAD sur la page Localisation.

Traduire la documentation

Traduire le wiki est facile, le wiki de FreeCAD est pris en charge par un plugin de traduction qui permet de gérer les traductions entre les pages.

Pour plus d'informations sur la traduction, voir le processus de traduction du Wiki de FreeCAD sur la page Localisation.

Assurez-vous de vous familiariser avec le guide de style Wiki WikiPages, qui comprend toutes les règles d'une bonne traduction.

La page Aide pour l'édition fournit des informations sur l'édition.

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 ferez sûrement des choses intéressantes pour FreeCAD. Aidez-nous à faire connaître aux autres ce que FreeCAD peut faire !
  • Postez sur le forum, et aidez les nouveaux arrivants, en répondant à leurs questions et à résoudre leurs problèmes.
  • Écrivez des didacticiels, faites des enregistrements vidéos, etc. montrant ce que vous faites avec FreeCAD.
  • Contribuez avec des fichiers, dessins, etc. Nous manquons encore de bons exemples de fichiers, de projets qui peuvent être réalisés avec 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. Afin de permettre aux développeurs d'économiser du temps (le triage, la manipulation et la compréhension de bogues difficiles à comprendre peuvent être très coûteux en temps), et d'éviter les frustrations dues aux questions posées, mal interprétées et comprises de façon erronée, s'il vous plaît lisez ce qui suit :

  • Les bogues et requêtes de fonctionnalités sont traitées 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 que vous puissiez soumettre des questions anonymement, s'il vous plaît utilisez votre compte sur sourceforge ou, (en créer un si nécessaire), de sorte que vous puissiez être averti, lorsque quelqu'un ajoute des notes à la question. Dans de nombreux 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 reproduire la même chose, et voir le bogue se reproduire sur sa machine. Si le développeur n'arrive pas voir le bogue, il ne peut pas non plus pas le résoudre.
  • Il faut également inclure des informations qui peuvent aider les développeurs à situer le problème, comme le système d'exploitation sur lequel vous exécutez FreeCAD, la version de FreeCAD utilisée (par exemple 0.11) et le numéro de révision (par exemple 4955). Ces deux numéros sont disponibles par le menu Aide → À propos de FreeCAD.
  • Si vous n'êtes pas sûr que ce vous avez trouvé est un bogue ou pas, il vaut mieux en discuter au préalable sur le forum.
  • Avant de soumettre une demande de fonctionnalité, une bonne idée serait aussi d'en discuter avec les autres utilisateurs du forum, de sorte que vous pourriez vous retrouver avec une proposition plus complète, et, plus de chances d'intéresser un programmeur de la mettre en œuvre.
  • Rappelez-vous que FreeCAD est développé par des bénévoles qui utilisent leurs 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é plus tard, ou abandonné, si vous ne pouvez pas donner les informations suffisantes pour la reproduire. Votre demande de fonctionnalité pourrait être reportée ou même abandonnée si aucun développeur ne peut s'en occuper, ou que pour la mettre en oeuvre, elle demande un travail beaucoup trop important.

Icônes FreeCAD

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

Program!

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. But to avoid some headache 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 is also participating to the Google Summer of Code. Be sure to check our ideas there if you are interested in participating in a next edition.