jPopper

A parent for Java maven projects with best practices and commonly used checks enforced.
Report Bug/Request Feature

Table of Contents

1. About The Project
2. Usage
3. Roadmap
4. Contributing
5. License

About The Project

This project is to serve as a parent maven project to enforce the following good practices and provide commonly used functionality:

• Checkstyle enforcement as per the Google java styling guide.
• PMD static code analysis to enforce good practices.
• Java code coverage check enforcement.

Usage

This project is only meant to be used as a parent maven project.
To do so:

1. Add this repository as a git submodule to the child project repository.
2. In the pom.xml of the child repository, add the following lines:

   <parent>
      <groupId>org.padaiyal</groupId>
      <artifactId>popper</artifactId>
      <version>2021.01.06</version>
      <relativePath>jPopper</relativePath>
   </parent>
   

   Replace the contents of the relativePath tag to the actual relative path of the submodule with respect to the child project's pom.xml.
3. To use the existing GitHub action Publish to GitHub packages, the distributionManagement section also needs to be configured in the child project's pom.xml.

   <distributionManagement>
       <repository>
           <id>github</id>
           <name>Child project MVN package deployment</name>
           <url>https://maven.pkg.github.com/<organization_or_user>/<repository_name></url>
       </repository>
   </distributionManagement>
   

   NOTE: Ensure that the child project's artifact ID follows the maven naming conventions. Else, GitHub packages would reject the upload with a HTTP 422: Unprocessable Entity error.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project.
2. Create your branch. (git checkout -b contribution/AmazingContribution)
3. Commit your changes. (git commit -m 'Add some AmazingContribution')
4. Push to the branch. (git push origin contribution/AmazingContribution)
5. Open a Pull Request.

License

Distributed under the Apache License. See LICENSE for more information.