-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
2 changed files
with
89 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
<!-- PROJECT SHIELDS --> | ||
<!-- | ||
*** I'm using markdown "reference style" links for readability. | ||
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ). | ||
*** See the bottom of this document for the declaration of the reference variables | ||
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use. | ||
*** https://www.markdownguide.org/basic-syntax/#reference-style-links | ||
--> | ||
<div align="center"> | ||
<h1 align="center">jPopper</h1> | ||
<p align="center"> | ||
A template for Java maven projects. | ||
<br /> | ||
<a href="https://github.com/padaiyal/jPopper/issues/new">Report Bug/Request Feature</a> | ||
</p> | ||
|
||
[![Contributors][contributors-shield]][contributors-url] | ||
[![Forks][forks-shield]][forks-url] | ||
[![Stargazers][stars-shield]][stars-url] | ||
[![Issues][issues-shield]][issues-url] | ||
[![Apache License][license-shield]][license-url] <br> | ||
![Maven build - Ubuntu latest](https://github.com/padaiyal/jPopper/workflows/Maven%20build%20-%20Ubuntu%20latest/badge.svg?branch=main) | ||
![Maven build - Windows latest](https://github.com/padaiyal/jPopper/workflows/Maven%20build%20-%20Windows%20latest/badge.svg?branch=main) | ||
![Maven build - MacOS latest](https://github.com/padaiyal/jPopper/workflows/Maven%20build%20-%20MacOS%20latest/badge.svg?branch=main) | ||
|
||
</div> | ||
|
||
<!-- TABLE OF CONTENTS --> | ||
<details open="open"> | ||
<summary>Table of Contents</summary> | ||
<ol> | ||
<li> | ||
<a href="#about-the-project">About The Project</a> | ||
</li> | ||
<li><a href="#roadmap">Roadmap</a></li> | ||
<li><a href="#contributing">Contributing</a></li> | ||
<li><a href="#license">License</a></li> | ||
</ol> | ||
</details> | ||
|
||
<!-- ABOUT THE PROJECT --> | ||
## 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. | ||
- Java code coverage check enforcement. | ||
- Property Utility - To read properties from files. | ||
- Internationalization Utility - To use internationalized strings. | ||
|
||
|
||
|
||
<!-- ROADMAP --> | ||
## Roadmap | ||
|
||
See the [open issues](https://github.com/padaiyal/jPopper/issues) for a list of proposed features (and known issues). | ||
|
||
|
||
|
||
<!-- CONTRIBUTING --> | ||
## 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 --> | ||
## License | ||
Distributed under the Apache License. See [`LICENSE`](https://github.com/padaiyal/jPopper/blob/main/LICENSE) for more information. | ||
|
||
|
||
<!-- MARKDOWN LINKS & IMAGES --> | ||
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> | ||
[contributors-shield]: https://img.shields.io/github/contributors/padaiyal/jPopper.svg?style=for-the-badge | ||
[contributors-url]: https://github.com/padaiyal/jPopper/graphs/contributors | ||
[forks-shield]: https://img.shields.io/github/forks/padaiyal/jPopper.svg?style=for-the-badge | ||
[forks-url]: https://github.com/padaiyal/jPopper/graphs/network/members | ||
[stars-shield]: https://img.shields.io/github/stars/padaiyal/jPopper.svg?style=for-the-badge | ||
[stars-url]: https://github.com/padaiyal/jPopper/stargazers | ||
[issues-shield]: https://img.shields.io/github/issues/padaiyal/jPopper.svg?style=for-the-badge | ||
[issues-url]: https://github.com/padaiyal/jPopper/issues | ||
[license-shield]: https://img.shields.io/github/license/padaiyal/jPopper.svg?style=for-the-badge | ||
[license-url]: https://github.com/padaiyal/jPopper/blob/master/LICENSE | ||
[product-screenshot]: images/screenshot.png |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters