distributedlog-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sijie <...@git.apache.org>
Subject [GitHub] incubator-distributedlog pull request #54: DL-129: Enable checkstyle plugin ...
Date Mon, 12 Dec 2016 19:58:47 GMT
Github user sijie commented on a diff in the pull request:

    https://github.com/apache/incubator-distributedlog/pull/54#discussion_r92025930
  
    --- Diff: distributedlog-build-tools/src/main/resources/distributedlog/checkstyle.xml
---
    @@ -0,0 +1,443 @@
    +<?xml version="1.0" encoding="UTF-8"?>
    +<!--
    +    Licensed to the Apache Software Foundation (ASF) under one or more
    +    contributor license agreements.  See the NOTICE file distributed with
    +    this work for additional information regarding copyright ownership.
    +    The ASF licenses this file to You under the Apache License, Version 2.0
    +    (the "License"); you may not use this file except in compliance with
    +    the License.  You may obtain a copy of the License at
    +
    +       http://www.apache.org/licenses/LICENSE-2.0
    +
    +    Unless required by applicable law or agreed to in writing, software
    +    distributed under the License is distributed on an "AS IS" BASIS,
    +    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    +    See the License for the specific language governing permissions and
    +    limitations under the License.
    +-->
    +<!DOCTYPE module PUBLIC
    +    "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
    +    "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
    +
    +<!-- This is a checkstyle configuration file. For descriptions of
    +what the following rules do, please see the checkstyle configuration
    +page at http://checkstyle.sourceforge.net/config.html -->
    +
    +<module name="Checker">
    +
    +  <module name="FileTabCharacter">
    +    <!-- Checks that there are no tab characters in the file. -->
    +  </module>
    +
    +  <module name="RegexpSingleline">
    +    <!-- Checks that TODOs don't have stuff in parenthesis, e.g., username. -->
    +    <property name="format" value="((//.*)|(\*.*))TODO\(" />
    --- End diff --
    
    it might be good to make sure there is a jira associated with TODO item?
    
    E.g. 
    
    "TODO: {@link jira_link}"?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message