Return-Path: X-Original-To: apmail-cordova-dev-archive@www.apache.org Delivered-To: apmail-cordova-dev-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 8A15C1111F for ; Wed, 23 Apr 2014 18:42:07 +0000 (UTC) Received: (qmail 63176 invoked by uid 500); 23 Apr 2014 18:42:06 -0000 Delivered-To: apmail-cordova-dev-archive@cordova.apache.org Received: (qmail 63108 invoked by uid 500); 23 Apr 2014 18:42:06 -0000 Mailing-List: contact dev-help@cordova.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@cordova.apache.org Delivered-To: mailing list dev@cordova.apache.org Received: (qmail 63100 invoked by uid 99); 23 Apr 2014 18:42:06 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 23 Apr 2014 18:42:06 +0000 X-ASF-Spam-Status: No, hits=1.5 required=5.0 tests=HTML_MESSAGE,RCVD_IN_DNSWL_LOW,SPF_PASS X-Spam-Check-By: apache.org Received-SPF: pass (athena.apache.org: domain of shazron@gmail.com designates 74.125.82.52 as permitted sender) Received: from [74.125.82.52] (HELO mail-wg0-f52.google.com) (74.125.82.52) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 23 Apr 2014 18:42:02 +0000 Received: by mail-wg0-f52.google.com with SMTP id b13so51644wgh.11 for ; Wed, 23 Apr 2014 11:41:41 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:in-reply-to:references:from:date:message-id:subject:to :content-type; bh=rYW7XkB6Nt2pX144QiGM1YghUjXPR31ngxq1WjqIQAg=; b=B6OPxz7Ic1BJCJB6+j3thrSHlwKKo0iZm9AoL0dOdN5ZBn0lMw4/PJZ8PsOsX3L44+ Pj52280oDcWslsMjwofFhh7aprLUlKtYulcQY17aYIiPo42puzPPnXR1Xp/9yASSch7l eAT9RoN8fQ79am/ffel0dSjPk9wTrNJ7GlMlPoa/mE/9FpnSPlDKYVtkoEop7xXppaqa zASPOSqlEW8rJzJlWMCMc+5NFH3b6LmJHttHIorwvZ6lOHl/+BuWfYJCxtX+k5orvFEV 6vrRIGByuv2HX7mgaUxrzaVgzgOh7FdXIooCCaLwFbTMeR1dvmfi2P22Zqx7YTdjUpaj MvFg== X-Received: by 10.180.11.178 with SMTP id r18mr2958925wib.41.1398278500950; Wed, 23 Apr 2014 11:41:40 -0700 (PDT) MIME-Version: 1.0 Received: by 10.227.32.69 with HTTP; Wed, 23 Apr 2014 11:41:00 -0700 (PDT) In-Reply-To: References: From: Shazron Date: Wed, 23 Apr 2014 11:41:00 -0700 Message-ID: Subject: Re: [Proposal] Cordova guidelines part of ContributorWorkflow To: "dev@cordova.apache.org" Content-Type: multipart/alternative; boundary=001a11c2aca258a95204f7ba1592 X-Virus-Checked: Checked by ClamAV on apache.org --001a11c2aca258a95204f7ba1592 Content-Type: text/plain; charset=UTF-8 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 > --001a11c2aca258a95204f7ba1592--