cordova-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Martin Gonzalez Glez <martin.c.glez.g...@gmail.com>
Subject Re: [Proposal] Cordova guidelines part of ContributorWorkflow
Date Wed, 23 Apr 2014 21:00:25 GMT
Yes, agree. I can remove it.


2014-04-23 15:25 GMT-05:00 Mark Koudritsky <kamrik@google.com>:

> The style guide contains the following two points that seem to partially
> contradict each other. Ok if we just delete the second one?
>
>    1. Remove unnecessary trailing whitespace in lines; this includes after
>    operators, commas, semicolons or braces.
>    2. trailing spaces - you should turn off "remove trailing spaces" in
>    your editor/IDE. That is, trailing spaces should be left in files. Not
>    doing this yields extra diff junk, and sometime trailing spaces are
>    significant.
>
>
>
> On Wed, Apr 23, 2014 at 2:41 PM, Shazron <shazron@gmail.com> wrote:
>
> > I'll add this to the wiki, but putting it out here as well for the other
> > platforms/plugins:
> >
> > cordova-ios uses uncrustify in a pre-commit hook:
> > https://github.com/apache/cordova-ios/tree/master/hooks that needs to be
> > added on a per clone basis. Saves me a lot of time when I do my own
> > commits. It can be configured for other languages. Could be a coho thing
> to
> > add these hooks when pulling down repos (gasp) ;)
> >
> > Also, regarding contributing, I added this issue for adding a
> > CONTRIBUTING.md to all our repos:
> > https://issues.apache.org/jira/browse/CB-6491
> >
> >
> >
> >
> >
> > On Wed, Apr 23, 2014 at 11:23 AM, Martin Gonzalez Glez <
> > martin.c.glez.glez@gmail.com> wrote:
> >
> > > Hi guys,
> > >
> > > As code contributor, I've been receiving feedback, comments, advice and
> > > more from the commiters. Part of the received feedback is about the
> > Cordova
> > > code style, best practices, and
> > > preferences about how to contribute code to the project, which existing
> > > APIs to use, and more.
> > >
> > > Because of that, I have added some advices about code style, practices
> > and
> > > preferences in the wiki page:
> > >
> > > https://wiki.apache.org/cordova/StyleGuide
> > >
> > > This kind of information it would be great for new Contributors
> involved
> > in
> > > code deliverance, to serve as initial guidance to follow.
> > >
> > > That said, I have a *proposal *for all of you guys if are agree.
> > > It's about adding this wiki page as part of the *ContributorWorkflow*;
> > the
> > > content attempts to explain basic styles, patterns, practices, and
> > methods
> > > used in the project. All new and existent code should conform to these
> > > guidelines in order to maintain structural quality and code
> readability,
> > > and to make software maintenance easier.
> > >
> > > This could be a *win-win* for all of us, allowing contributors to
> provide
> > > high quality code, and reducing the burden on committers to provide
> > > individual feedback about the code style practices and standards that
> are
> > > currently applied in the Cordova source code.
> > >
> > > For contributors following these style guidelines, their code it will
> be
> > > easier to review and merge into the project quickly.
> > >
> > > Well, that's the proposal that I have, if you are agree with it, please
> > > check the few lines that I've added to the Style guide page, and feel
> > > yourself free to add more information, comments, practices,
> > > recommendations, modify the current ones, whatever that you can provide
> > it
> > > would be great.
> > >
> > > If you don't have permission to add information the Wiki page, you can
> > ask
> > > to a commiter for access to it. Or you can share a replay with the
> > > information that you'd like to add, and I'll be happy to post it.
> > >
> > > Thanks.
> > > -Martin
> > >
> >
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message