FreeCAD News

(“Mag­ic Book” by Mike Haufe is licensed under CC BY-NC 2.0.)

One of the new ini­tia­tives we are under­tak­ing is the cre­ation of a Devel­op­er’s Hand­book. It con­tains sec­tions about the Roadmap, out­lin­ing the broad objec­tives of the project, a Style­book to give devel­op­ers advice about GUI design and con­sis­ten­cy, and a Main­tain­ers Guide, detail­ing what, exact­ly, Main­tain­ers are sup­posed to be doing and how they should con­duct code reviews, etc.

If you just fol­lowed those links you may have noticed a cer­tain lack of detail, at least in some places. That’s where you come in! We’ve just start­ed this project. It’s host­ed on GitHub, and we are very much open to Pull Requests, help­ing us refine the var­i­ous sec­tions. Of course the entire doc­u­ment is a work-in-progress, and to a cer­tain extent always will be. But there are plen­ty of areas to con­tribute to. You are also wel­come to file Issues on GitHub if you have ideas for changes but aren’t ready to do any writ­ing yet, or if you think some­thing is unclear, or if you dis­agree with some­thing the Hand­book says.