Spotbugs plugin (#32)

* Added spotbugs profile plugin

CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [4.2.0] - TBD
+### Added
+- Added `spotbugs-maven-plugin`, version 3.1.12.2.
+### Changed
+- Updated `hotels-oss-plugin-config` version to 1.3.0 (was 1.2.2).
+- Changed `overWrite` to `true` in `maven-dependency-plugin` configuration.
+
 ## [4.1.0] - 2019-06-27
 ### Added
 - Added a check-for-updates profile which verifies if there are dependencies that can be upgraded.

CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# How To Contribute
+
+We'd love to accept your patches and contributions to this project. There are just a few guidelines you need to follow which are described in detail below.
+
+## 1. Fork this repo
+
+You should create a fork of this project in your account and work from there. You can create a fork by clicking the fork button in GitHub.
+
+## 2. One feature, one branch
+
+Work for each new feature/issue should occur in its own branch. To create a new branch from the command line:
+```shell
+git checkout -b my-new-feature
+```
+where "my-new-feature" describes what you're working on.
+
+## 3. Add documentation for new or updated functionality
+
+Please review all of the .md files in this project to see if they are impacted by your change and update them accordingly.
+
+## 4. Add to CHANGELOG.md
+
+Any notable changes should be recorded in the CHANGELOG.md following the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) conventions.
+
+## 5. Submit Pull Request and describe the change
+
+Push your changes to your branch and open a pull request against the parent repo on GitHub. The project administrators will review your pull request and respond with feedback.
+
+# How Your Contribution Gets Merged
+
+Upon Pull Request submission, your code will be reviewed by the maintainers. They will confirm at least the following:
+
+- Tests run successfully (unit, coverage, integration, style).
+- Contribution policy has been followed.
+
+Two (human) reviewers will need to sign off on your Pull Request before it can be merged.

pom.xml

@@ -4,7 +4,7 @@
 
   <groupId>com.hotels</groupId>
   <artifactId>hotels-oss-parent</artifactId>
-  <version>4.1.1-SNAPSHOT</version>
+  <version>4.2.0-SNAPSHOT</version>
   <description>Parent POM for Hotels.com open source projects</description>
   <packaging>pom</packaging>
   <url>https://github.com/HotelsDotCom/hotels-oss-parent</url>
@@ -45,7 +45,8 @@
     <coveralls.maven.plugin.version>4.3.0</coveralls.maven.plugin.version>
     <failsafe.maven.plugin.version>2.22.0</failsafe.maven.plugin.version>
     <findbugs.maven.plugin.version>3.0.5</findbugs.maven.plugin.version>
-    <hotels.oss.plugin.config.version>1.2.2</hotels.oss.plugin.config.version>
+    <spotbugs.maven.plugin.version>3.1.12.2</spotbugs.maven.plugin.version>
+    <hotels.oss.plugin.config.version>1.3.0</hotels.oss.plugin.config.version>
     <jacoco.version>0.8.4</jacoco.version>
     <jdk.version>1.8</jdk.version>
     <license.maven.plugin.version>3.0</license.maven.plugin.version>
@@ -68,6 +69,11 @@
     <maven.gpg.plugin.version>1.6</maven.gpg.plugin.version>
     <nexus.staging.maven.plugin.version>1.6.8</nexus.staging.maven.plugin.version>
     <lifecycle.mapping.version>1.0.0</lifecycle.mapping.version>
+
+    <!-- hotels.com specific plugin properties -->
+    <findbugs.config>${project.build.directory}/plugin-config/findbugs/hotels-findbugs-exclude.xml</findbugs.config>
+    <spotbugs.config>${project.build.directory}/plugin-config/spotbugs/hotels-spotbugs-exclude.xml</spotbugs.config>
+    <checkstyle.config>${project.build.directory}/plugin-config/checkstyle/hotels-checkstyle.xml</checkstyle.config>
   </properties>
 
   <distributionManagement>
@@ -101,7 +107,7 @@
                   <artifactId>hotels-oss-plugin-config</artifactId>
                   <version>${hotels.oss.plugin.config.version}</version>
                   <type>jar</type>
-                  <overWrite>false</overWrite>
+                  <overWrite>true</overWrite>
                   <outputDirectory>${project.build.directory}/plugin-config</outputDirectory>
                 </artifactItem>
               </artifactItems>
@@ -188,12 +194,24 @@
           <excludeFilterFile>${findbugs.config}</excludeFilterFile>
         </configuration>
       </plugin>
+      <plugin>
+        <groupId>com.github.spotbugs</groupId>
+        <artifactId>spotbugs-maven-plugin</artifactId>
+        <version>${spotbugs.maven.plugin.version}</version>
+        <configuration>
+          <encoding>${project.build.sourceEncoding}</encoding>
+          <xmlOutput>true</xmlOutput>
+          <effort>Max</effort>
+          <threshold>Low</threshold>
+          <excludeFilterFile>${spotbugs.config}</excludeFilterFile>
+        </configuration>
+      </plugin>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-checkstyle-plugin</artifactId>
         <version>${maven.checkstyle.plugin.version}</version>
         <configuration>
-          <configLocation>file://${project.build.directory}/plugin-config/checkstyle/hotels-checkstyle.xml</configLocation>
+          <configLocation>${checkstyle.config}</configLocation>
         </configuration>
       </plugin>
       <plugin>