SO Committers, RE: Conversation below
Can we agree to enforce code style and standards? Does anyone have arguments against this? Thanks, Marcus Williams IRC, Twitter, etc. @ mgkwill Intel Corp. From: SMOKOWSKI, STEVEN [mailto:[email protected]] Sent: Friday, August 3, 2018 11:59 AM To: Williams, Marcus <[email protected]>; [email protected] Subject: Re: [onap-discuss] [SO] Committer's enforcing ONAP Code Standards? From what I have seen most do not allow configuration. I looked it appears you would have to fork the repo. I think you should enforce it, or we can automate applying it via maven or another mechanism. Thanks -Steve From: "Williams, Marcus" <[email protected]<mailto:[email protected]>> Date: Friday, August 3, 2018 at 2:29 PM To: "SMOKOWSKI, STEVEN" <[email protected]<mailto:[email protected]>>, "[email protected]<mailto:[email protected]>" <[email protected]<mailto:[email protected]>> Subject: RE: [onap-discuss] [SO] Committer's enforcing ONAP Code Standards? Counter question: Do the tools you refer to allow style modification? If not we can discuss unmodified google standard. I can see us doing some effort to clean things up in one swoop and then maintaining or during each new code change we force the authors to fix style. Over time that would have the same effect. Second question: Do committers agree to enforce style when reviewing? If the second question is no, there is no point in making the first effort. Thanks, Marcus Williams IRC, Twitter, etc. @ mgkwill Intel Corp. From: SMOKOWSKI, STEVEN [mailto:[email protected]] Sent: Friday, August 3, 2018 6:18 AM To: [email protected]<mailto:[email protected]>; Williams, Marcus <[email protected]<mailto:[email protected]>> Subject: Re: [onap-discuss] [SO] Committer's enforcing ONAP Code Standards? Can we allow for usage of the unmodified google standard? There appears to be tools that can mass apply the style changes instead of doing this manually. Thanks -Steve From: <[email protected]<mailto:[email protected]>> on behalf of Marcus G K Williams <[email protected]<mailto:[email protected]>> Reply-To: "[email protected]<mailto:[email protected]>" <[email protected]<mailto:[email protected]>>, "[email protected]<mailto:[email protected]>" <[email protected]<mailto:[email protected]>> Date: Thursday, August 2, 2018 at 7:59 PM To: onap-discuss <[email protected]<mailto:[email protected]>> Subject: [onap-discuss] [SO] Committer's enforcing ONAP Code Standards? Hi SO Committers, PTL and community, I think we have an opportunity to be an earlier adopter in the community. I’d like to propose that we work on conforming our codebase to ONAP code standards: https://wiki.onap.org/display/DW/Java+code+style<https://urldefense.proofpoint.com/v2/url?u=https-3A__wiki.onap.org_display_DW_Java-2Bcode-2Bstyle&d=DwMFAg&c=LFYZ-o9_HUMeMTSQicvjIg&r=shs6nPzThSiGJml9VXN0Eg&m=QS8ChNU1J4hFEt2Je8cDwocP613mTgL-3KHgarIQiio&s=Qcs1ANr2t3aXNxIRcPqBDQUczIM97rihRSDQvFq2JF8&e=> Generally this entails 4 spaces in place of tabs, 120 character line limit and google style guidelines, which largely follow generally accepted Java Style. Our codebase does not currently conform to these standards. Further some of the style issues result in a very large amount of warnings in build logs (last time I counted it was 10s of thousands), which increase build time and space used by Jenkins/LF for each build. We should also make sure we don’t have extraneous spaces (gerrit highlights those in red and having them in open source code is generally frowned upon by any self-respecting open source engineer). Does anyone have any problem with working to make the code conform to style guidelines? Can we agree to -1 changes that do not conform until the submitter conforms the patch to style guidelines? As a corollary I’d suggest we enforce commit message guidelines as well: https://wiki.onap.org/display/DW/Commit+Messages<https://urldefense.proofpoint.com/v2/url?u=https-3A__wiki.onap.org_display_DW_Commit-2BMessages&d=DwMFAg&c=LFYZ-o9_HUMeMTSQicvjIg&r=shs6nPzThSiGJml9VXN0Eg&m=QS8ChNU1J4hFEt2Je8cDwocP613mTgL-3KHgarIQiio&s=_YpEK0IfkshQNrVrSiZ7I3k7xhLJuFqYVqyeS58Ur6g&e=> Thanks, Marcus Williams IRC, Twitter, etc. @ mgkwill Intel Corp. -=-=-=-=-=-=-=-=-=-=-=- Links: You receive all messages sent to this group. View/Reply Online (#11692): https://lists.onap.org/g/onap-discuss/message/11692 Mute This Topic: https://lists.onap.org/mt/24149869/21656 Group Owner: [email protected] Unsubscribe: https://lists.onap.org/g/onap-discuss/unsub [[email protected]] -=-=-=-=-=-=-=-=-=-=-=-
