Hello, The document is really nice and keeps the code clean avoiding any syntactical inconsistencies.
Some of the previous companies I worked at followed MISRA C coding standards which was sought after by the automotive industry mostly in the UK. Do we want to take a look at it and think of adhering to some of the rules mentioned by them if not all. The automotive industry has been using ARM controllers for ages and take the MISRA standards quite seriously. I could see several use cases: 1. Making our code safety critical, portable most of which we might be doing anyways. 2. Adoption by the automotive industry 3. Producing Lint free code (Less issues on doing Static code analysis - On running PC Lint/Coverity) I would not worry about any of this if it was a single product we were targeting. Since it is an OS and we want people to adopt it, some of them might be from an automotive background who trust MISRA C standards more than they trust us. This might be a separate discussion and sorry to bring this up if it’s not needed here. Having said all that, from a developers perspective I think the document is really good and does a very good job at addressing inconsistencies in the code. We might want to add an example of a C++ style comment: Something that we don’t want our code filled up with “//“ :-) Regards, Vipul Rahane > On Apr 24, 2016, at 10:08 AM, Sterling Hughes <[email protected]> wrote: > > Hi, > > As we start to bring on new contributors, and operate as a project, its > increasingly important that we document and agree upon coding standards. I > think we've done a good job of maintaining this consistency informally, but, > now we need to vote and agree on project standards. > > I've taken a first stab at this and committed it to the develop branch, folks > can see it here: > > https://github.com/apache/incubator-mynewt-core/blob/develop/CODING_STANDARDS.md > > I think next steps are: > > - If you have formatting fixes, or clarifications that don't change the > contents, just go ahead and edit the document. > > - If you disagree with something in the document, or think it should be > changed in some way, respond back to this thread. > > - If you have additions or rules that you don't think were captured, respond > back to this thread, along with the proposed text. If nobody objects, I'll > just fold them into whatever other revisions we decide to make. > > After we give this a round of discussion, I'll capture all the feedback and > do a rev of the document. If nobody has any issues with that rev, we can > vote to officially adopt these coding standards. I personally think this > should be an up or down vote. > > Well - OK, let the conversations begin :-) > > Sterling
