search

OpenIR / IRSmartLib

An experimental port of Arduino-IRremote
GNU Lesser General Public License v2.1
3 stars 1 forks source link

Adapt arduino API styleguide to contributing.md #2

Open z3t0 opened 9 years ago

z3t0 commented 9 years ago

https://www.arduino.cc/en/Reference/APIStyleGuide

bengtmartensson commented 9 years ago

(You mean "adapt to API styleguide", rite?)

I vote NO.

Some of these run counter to professional programming practice. We’re aware of that, but it’s what’s made it possible for so many beginners to get started with Arduino easily.

I consider this a very bad idea. C++-libraries should be optimized for readability, maintainability, in some cases for performance, NOT what some amateur IT pedagogues (without any quoted sources in academic research) consider accessibility by beginners.

z3t0 commented 9 years ago

(You mean "adapt to API styleguide", rite?)

Ha ha, I really love word play :smile:. But no, I mean "Adapt Styleguide", meaning Adapt the style guide into our own style guide which need to be observed by contributors. I never actually took the time to read through the style guide and assumed it was well written, so the plan was that we would work through modifying some important points and then make our own version. However, if it is as bad as you say we may want to look at a more traditional C++ style guide. I think it would be a good idea if we followed a style guide to keep code much more easily maintainable.

z3t0 commented 9 years ago

Changed the title, should be clearer now