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

ASF GitHub Bot commented on METRON-1087:
----------------------------------------

GitHub user justinleet reopened a pull request:

    https://github.com/apache/metron/pull/685

    METRON-1087: Adjust license headers to be comments instead of Javadoc

    ## Contributor Comments
    This does three things:
    1. Changes Javadoc to just plain comment.
    2. Fixes headers that have been affected by formatting (get rid of 
paragraph tags, weird formatting, and deleted spaces, etc.)
    3. Adds a newline after the license, before the package statement.
    
    Even though this affects a (very) large number of files, I left it as one 
PR.  This is mostly because even though there's many changes, the vast, vast 
majority are changing `/**` to `/*` and adding a newlines.  Only a couple dozen 
files actually have fixes beyond that.  If this is too large, too tedious, or 
GitHub does weird crap, let me know and I can split this up.  It was just 
easier when making the change to just find/replace and validate correctness 
afterwards.
    
    Note that the newline in 3 is to meet the [Google Java Style 
Guide](https://google.github.io/styleguide/javaguide.html#s3-source-file-structure).
  This is not handled by the IDE formatter (at least in IntelliJ), 
unfortunately.
    ```
    A source file consists of, in order:
    
    1. License or copyright information, if present
    2. Package statement
    3. Import statements
    4. Exactly one top-level class
    Exactly one blank line separates each section that is present.
    ```
    
    Validation is just opening a file and ensuring that autoformat doesn't 
change the license header.
    
    ~I still need to spin up full dev as a precaution, but given that it's all 
comments and whitespace, I'm expecting no issues.~
    
    ## Pull Request Checklist
    
    Thank you for submitting a contribution to Apache Metron.  
    Please refer to our [Development 
Guidelines](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61332235)
 for the complete guide to follow for contributions.  
    Please refer also to our [Build Verification 
Guidelines](https://cwiki.apache.org/confluence/display/METRON/Verifying+Builds?show-miniview)
 for complete smoke testing guides.  
    
    
    In order to streamline the review of the contribution we ask you follow 
these guidelines and ask you to double check the following:
    
    ### For all changes:
    - [x] Is there a JIRA ticket associated with this PR? If not one needs to 
be created at [Metron 
Jira](https://issues.apache.org/jira/browse/METRON/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel).
 
    - [x] Does your PR title start with METRON-XXXX where XXXX is the JIRA 
number you are trying to resolve? Pay particular attention to the hyphen "-" 
character.
    - [x] Has your PR been rebased against the latest commit within the target 
branch (typically master)?
    
    
    ### For code changes:
    - [x] Have you included steps to reproduce the behavior or problem that is 
being changed or addressed?
    - [x] Have you included steps or a guide to how the change may be verified 
and tested manually?
    - [x] Have ]you ensured that the full suite of tests and checks have been 
executed in the root metron folder via:
      ```
      mvn -q clean integration-test install && build_utils/verify_licenses.sh 
      ```
    
    - [x] Have you verified the basic functionality of the build by building 
and running locally with Vagrant full-dev environment or the equivalent?
    
    ### For documentation related changes:
    - [x] Have you ensured that format looks appropriate for the output in 
which it is rendered by building and verifying the site-book? If not then run 
the following commands and the verify changes via 
`site-book/target/site/index.html`:
    
      ```
      cd site-book
      mvn site
      ```
    
    #### Note:
    Please ensure that once the PR is submitted, you check travis-ci for build 
issues and submit an update to your PR as soon as possible.
    It is also recommended that [travis-ci](https://travis-ci.org) is set up 
for your personal repository such that your branches are built there before 
submitting a pull request.
    


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/justinleet/metron license_comment_fix

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/metron/pull/685.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #685
    
----
commit 8a93d11389d8f2e961873470faea396bd311f83f
Author: justinjleet <justinjl...@gmail.com>
Date:   2017-08-04T19:18:13Z

    Making the license not javadoc and putting newline before package

commit c584d88b4e177959e158436f11d444cac66eb562
Author: justinjleet <justinjl...@gmail.com>
Date:   2017-08-04T19:21:16Z

    Fixing urls in licenses

commit e5b99c69450fa83b898a5f929e76725df876aee5
Author: justinjleet <justinjl...@gmail.com>
Date:   2017-08-11T11:53:04Z

    Merge branch 'master' into license_comment_fix

----


> Adjust license headers to be comments instead of Javadoc
> --------------------------------------------------------
>
>                 Key: METRON-1087
>                 URL: https://issues.apache.org/jira/browse/METRON-1087
>             Project: Metron
>          Issue Type: Improvement
>    Affects Versions: 0.4.0
>            Reporter: Justin Leet
>            Assignee: Justin Leet
>            Priority: Minor
>
> Right now, the majority of our license headers are in Javadoc format.
> Notably, Javadoc is subject to reformatting from IDE autoformatters.  In some 
> cases, this has resulted in the whitespace being replaced by paragraph tags, 
> or the removal or some spaces.  Additionally, reformats to fit the column 
> width setup.  Comments maintain formatting, and should be preferred for this 
> reason.
> Not adjusting this will causes significant issues for 
> https://issues.apache.org/jira/browse/METRON-747, as blanket reformat can 
> cause issues will all the license headers.



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

Reply via email to