hadoop-hdfs-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Haohui Mai (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (HDFS-9328) Formalize coding standards for libhdfs++ and put them in a README.txt
Date Thu, 05 Nov 2015 21:14:27 GMT

    [ https://issues.apache.org/jira/browse/HDFS-9328?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14992486#comment-14992486
] 

Haohui Mai commented on HDFS-9328:
----------------------------------

It's better to have the file in markdown format, preferably naming it as {{CONTRIBUTING.md}}.

I would not put (4) in until we actually start implementing short-circuit reads. I anticipate
that the complexity will be abstracted away through platform specific header files.

The whole point of having {{clang-format}} is to eliminate the debates on how one formatting
is more readable to another. As long as the project has a consistent style, it's much better
to leave formatting to a program instead of debating readability.

> Formalize coding standards for libhdfs++ and put them in a README.txt
> ---------------------------------------------------------------------
>
>                 Key: HDFS-9328
>                 URL: https://issues.apache.org/jira/browse/HDFS-9328
>             Project: Hadoop HDFS
>          Issue Type: Sub-task
>          Components: hdfs-client
>            Reporter: James Clampffer
>            Assignee: James Clampffer
>            Priority: Blocker
>         Attachments: HDFS-9328.HDFS-8707.000.patch
>
>
> We have 2-3 people working on this project full time and hopefully more people will start
contributing.  In order to efficiently scale we need a single, easy to find, place where developers
can check to make sure they are following the coding standards of this project to both save
their time and save the time of people doing code reviews.
> The most practical place to do this seems like a README file in libhdfspp/. 
> The foundation of the standards is google's C++ guide found here: https://google-styleguide.googlecode.com/svn/trunk/cppguide.html
> Any exceptions to google's standards or additional restrictions need to be explicitly
enumerated so there is one single point of reference for all libhdfs++ code standards.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message