Apache Drill
  1. Apache Drill
  2. DRILL-46

Setup contributing page and coding style guidelines

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.0.0-milestone-1
    • Labels:
      None

      Description

      Like most projects at apache Drill needs to have a coding style set up.

        Activity

        Hide
        Jacques Nadeau added a comment -

        Good for now

        Show
        Jacques Nadeau added a comment - Good for now
        Hide
        David Alves added a comment - - edited

        Updated the "Contributing" page to address Jacques comments, namely:

        • moved the test framework to JUnit 4.1
        • added Review Board link and submission guidelines to the review process.
        • added a link to a brief tutorial on "git-am"

        Please Review, and/or +1 so that I can close.

        Show
        David Alves added a comment - - edited Updated the "Contributing" page to address Jacques comments, namely: moved the test framework to JUnit 4.1 added Review Board link and submission guidelines to the review process. added a link to a brief tutorial on "git-am" Please Review, and/or +1 so that I can close.
        Hide
        Jacques Nadeau added a comment -

        Fair point on patches.

        Show
        Jacques Nadeau added a comment - Fair point on patches.
        Hide
        David Alves added a comment -

        I'll update the page wrt to junit and reviewboard.
        With regard to pull requests (with patch extension) I think they are great for WIP reviews but that we should refrain from using them for patches of any kind. The reasoning is that, because the patch is dynamically generated based on the curent diff, the pull requester could change the patch at any time after the review and before the merge.

        Show
        David Alves added a comment - I'll update the page wrt to junit and reviewboard. With regard to pull requests (with patch extension) I think they are great for WIP reviews but that we should refrain from using them for patches of any kind. The reasoning is that, because the patch is dynamically generated based on the curent diff, the pull requester could change the patch at any time after the review and before the merge.
        Hide
        Jacques Nadeau added a comment -

        Thanks for 'adapting' this. Couple things: we're using a later version of Junit (4.x) so the requirements are much less (just @Test annotation). For patch application, maybe update with instructions for git-am. We should also state use of review board for reviews and pull request as an alternative to attached patch for simple changes.

        Show
        Jacques Nadeau added a comment - Thanks for 'adapting' this. Couple things: we're using a later version of Junit (4.x) so the requirements are much less (just @Test annotation). For patch application, maybe update with instructions for git-am. We should also state use of review board for reviews and pull request as an alternative to attached patch for simple changes.
        Hide
        David Alves added a comment -

        I've adapted (cough blatantly copie cough) the "Contributing" page from Hive and added our specifics (maven, git etc) and formatter configurations.
        Those can be found at: https://cwiki.apache.org/confluence/display/DRILL/Contributing

        Please review!

        Show
        David Alves added a comment - I've adapted ( cough blatantly copie cough ) the "Contributing" page from Hive and added our specifics (maven, git etc) and formatter configurations. Those can be found at: https://cwiki.apache.org/confluence/display/DRILL/Contributing Please review!
        Hide
        David Alves added a comment -

        I've added a "Contributing" entry to the wiki that refers to HBase's page (unless you'd prefer to copy it).
        I've also added links to formatter configuration files for IDEA and Eclipse that follow the HBase code conventions.

        Show
        David Alves added a comment - I've added a "Contributing" entry to the wiki that refers to HBase's page (unless you'd prefer to copy it). I've also added links to formatter configuration files for IDEA and Eclipse that follow the HBase code conventions.
        Hide
        David Alves added a comment -

        +1 on those.

        I'll update the wiki.

        Show
        David Alves added a comment - +1 on those. I'll update the wiki.
        Hide
        Jacques Nadeau added a comment -

        I'm basically using the HBase eclipse formatting styles for my work. Only difference is increasing maximum line length to 120. See http://hbase.apache.org/book.html#eclipse. How about we start with those and then update as necessary. Do you want to doc it on the Wiki?

        Show
        Jacques Nadeau added a comment - I'm basically using the HBase eclipse formatting styles for my work. Only difference is increasing maximum line length to 120. See http://hbase.apache.org/book.html#eclipse . How about we start with those and then update as necessary. Do you want to doc it on the Wiki?

          People

          • Assignee:
            David Alves
            Reporter:
            David Alves
          • Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development