ebegu-code-convetions

This repository provides a collection of code-convention rules that are checked by tools like findbugs, pmd and checkstyle. It was developed for the ebegu project.

Getting Started

These instructions will get you an overview on how to implement and use the dvbern-lib-beanvalidation library. See further down for installing or deployment notes.

Built With

• Maven - Dependency Management

Installation

• Checkout the repository
• run mvn clean install
• add the following plugin to your project

                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-checkstyle-plugin</artifactId>
                    <version>${maven-checkstyle-plugin.version}</version>
                    <configuration>
                        <configLocation>rules/ebegu/checkstyle/checkstyle-rules.xml</configLocation>
                        <suppressionsLocation>rules/ebegu/checkstyle/checkstyle-suppressions.xml</suppressionsLocation>
                        <violationSeverity>warning</violationSeverity>
                    </configuration>
                    <dependencies>
                        <dependency>
                            <groupId>ch.dvbern.oss.maven</groupId>
                            <artifactId>ebegu-code-conventions</artifactId>
                            <version>(newest Version)</version>
                        </dependency>
                    </dependencies>
                </plugin>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-pmd-plugin</artifactId>
                    <version>${maven-pmd-plugin.version}</version>
                    <configuration>
                        <rulesets>
                            <ruleset>rules/ebegu/pmd/pmd-rules.xml</ruleset>
                        </rulesets>
                    </configuration>
                    <dependencies>
                        <dependency>
                            <groupId>ch.dvbern.oss.maven</groupId>
                            <artifactId>ebegu-code-conventions</artifactId>
                            <version>(newest Version)</version>
                        </dependency>
                    </dependencies>
                </plugin>
                <plugin>
                    <groupId>org.codehaus.mojo</groupId>
                    <artifactId>findbugs-maven-plugin</artifactId>
                    <version>${findbugs-maven-plugin.version}</version>
                    <dependencies>
                        <dependency>
                            <groupId>ch.dvbern.oss.maven</groupId>
                            <artifactId>ebegu-code-conventions</artifactId>
                            <version>(newest Version)</version>
                        </dependency>
                    </dependencies>
                    <configuration>
                        <includeFilterFile>rules/ebegu/findbugs/findbugs-includes.xml</includeFilterFile>
                        <excludeFilterFile>rules/ebegu/findbugs/findbugs-excludes.xml</excludeFilterFile>
                    </configuration>
                </plugin>

Contributing Guidelines

Please read CONTRIBUTING.md for the process for submitting pull requests to us.

Code of Conduct

One healthy social atmospehere is very important to us, wherefore we rate our Code of Conduct high. For details check the file CODE_OF_CONDUCT.md

Authors

• DV Bern AG - Initial work - dvbern

See also the list of contributors who participated in this project.

License

This project is licensed under the Apache 2.0 License - see the License.md file for details.