Read this first if you want to write code for FreeCAD

Here's the place for discussion related to coding in FreeCAD, C++ or Python. Design, interfaces and structures.
User avatar
yorik
Site Admin
Posts: 8684
Joined: Tue Feb 17, 2009 9:16 pm
Location: São Paulo, Brazil
Contact:

Read this first if you want to write code for FreeCAD

Postby yorik » Thu May 24, 2012 2:53 am

If you want to write code for FreeCAD, you are very welcome, your work will be greatly appreciated. But you should also be aware of the following points:

  • FreeCAD 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 issue tracker at http://www.freecadweb.org/tracker also contains some items that are not yet assigned to anybody, that you might be interested to work on. In this case, add a comment to the issue saying you would like to work on it.
  • Before you start to code for FreeCAD, you must have a good knowledge of the application itself. This might seem obvious, but the OpenCascade kernel of FreeCAD is very complex, and you won't go very far if you don't know how it works, what it can do and what are its limitations.
  • Almost everything can be done either in python or C++, depending on your preference. The internals work almost the same in both languages. You are strongly encouraged to read through the python documentation on the FreeCAD wiki, even if you plan to work in C++, since it will explain you the biggest part of the concepts used in the application.
  • If you are going to work in C++, make sure you are able compile FreeCAD successfully. If you will work in python, this is not necessary.
  • Present yourself to other developers. FreeCAD is before anything a social project, we discuss almost everything on this 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. Many users of this forum are long-time members of the FreeCAD community, have a deep knowledge of the application and can give you a lot of feedback. We also have an IRC channel, but this forum is the one and only place where you can meet all the developers and knowledgeable users.
  • The best way to submit your work is to post a patch on the issue tracker at http://www.freecadweb.org/tracker, but you can also publish a branch on a public git repository such as github or gitorious, and request a merge on this forum, or better, open a request on the tracker.
phreed
Posts: 1
Joined: Wed Jun 20, 2012 2:22 pm

Re: Read this first if you want to write code for FreeCAD

Postby phreed » Wed Jun 20, 2012 2:26 pm

"Present yourself to other developers."
Where should I introduce myself?
wmayer
Site Admin
Posts: 11356
Joined: Thu Feb 19, 2009 10:32 am

Re: Read this first if you want to write code for FreeCAD

Postby wmayer » Wed Jun 20, 2012 2:52 pm

You can post on the Open discussion forum or on the developer corner.
mrlukeparry
Posts: 652
Joined: Fri Jul 22, 2011 8:37 pm
Contact:

Re: Read this first if you want to write code for FreeCAD

Postby mrlukeparry » Tue Aug 07, 2012 11:44 am

I only started helping FreeCAD since last year and I've learnt a lot considering I could barely write c++ without the compiler throwing errors. Anything is possible! I want to share some helpful guides for anyone that's new to developing FreeCAD. I'm slowly making posts to help people getting started developing FreeCAD using c++ on my blog:

@http://freecadamusements.blogspot.co.uk/search/label/FreeCAD%20Development%20Help
User avatar
emagdalena
Posts: 15
Joined: Mon Sep 19, 2011 8:32 pm
Location: Vigo
Contact:

Re: Read this first if you want to write code for FreeCAD

Postby emagdalena » Thu Aug 09, 2012 6:55 pm

Nice work!!
Luke, the next week I´ll be learning something about write C++ and Python code in FreeCAD
Smile, breathe and go slowly...
JoseAntonioGutierrez
Posts: 4
Joined: Tue Feb 17, 2015 12:35 pm

Re: Read this first if you want to write code for FreeCAD

Postby JoseAntonioGutierrez » Wed Feb 25, 2015 5:18 pm

Hello everyone. My name is Jose Antonio Gutierrez. I'm industrial engineer and I have programming knowledge and CAD programs like CATIA, Sketchup, 3DsMAX...but not in python language.I'd like be a good collaborator so FreeCAD be so good and useful like CATIA is!!
vitorvitorvitor88
Posts: 1
Joined: Tue Jun 23, 2015 12:40 am

Re: Read this first if you want to write code for FreeCAD

Postby vitorvitorvitor88 » Tue Jun 23, 2015 12:59 am

Hello, my name is Vitor dos Santos, I'm computer engineer at Brazil and must help the great FreeCad Project.

I feel honored to be here.
jmaustpc
Posts: 8101
Joined: Tue Jul 26, 2011 6:28 am
Location: Australia

Re: Read this first if you want to write code for FreeCAD

Postby jmaustpc » Sat Aug 01, 2015 8:59 am

I have locked this topic to stop people posting messages that would be more appropriate in a new topic so that this announcement topic remains short, relevant, "to the point', easy to comprehend and hence more likely to be read. :)

If anyone wants to post something relevant and does not have adequate permissions level to undo my lock then please feel free to send a PM me or one or several, of the admins/moderators and we will happily allow you to add to this topic. :)