Skip to content

Commit

Permalink
Issue #5: Document the Java/Kotlin Example Project
Browse files Browse the repository at this point in the history
  • Loading branch information
ALRubinger committed Nov 14, 2024
1 parent e7fe8ec commit a544961
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
contact_links:
- name: ❓ Questions and Help 🤔
url: https://discord.gg/tbd (/add your discord channel if applicable)
url: https://discord.gg/block (/add your discord channel if applicable)
about: This issue tracker is not for support questions. Please refer to the community for more help.
29 changes: 26 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,32 @@
# $PROJECT_NAME README
# Java Maven Multimodule Example

Congrats, project leads! You got a new project to grow!
This project is a starting point, a template, to kickstart your work.
It's designed to get you building as quickly as possible - with best practices
and services built in. It's designed to work with the Block Open Source Program,
but may be adapted for other purposes.

Features include:
* Multimodule Maven project structure with 2 built-in modules: `api` and `impl`.
* [Hermit](https://cashapp.github.io/hermit/) managed environment (Java, Maven)
* GitHub Actions for Continuous Integration:
* Testing in both MacOS and Ubuntu environments
* Every commit to `main` published as `SNAPSHOT` in Block Artifactory
* Static Analysis ([CodeQL](https://codeql.github.com/))
* License scanning ([FOSSA](https://fossa.com/))
* Security Vulnerability detection for dependencies ([FOSSA](https://fossa.com/))
* Automatic dependency upgrades ([Renovate](https://github.com/renovatebot/renovate))
* Release and Publishing to [Maven Central](https://central.sonatype.com/)

To build a project using this template as a base,
[create a new repository](https://github.com/organizations/block/repositories/new). Select
`block/example-java-kotlin-maven-multimodule` as the `Repository template`.

---

# README Template

This stub is meant to help you form a strong community around your work. It's yours to adapt, and may
diverge from this initial structure. Just keep the files seeded in this repo, and the rest is yours to evolve!
diverge from this initial structure. Just keep the files seeded in this repo, and the rest is yours to evolve!

## Introduction

Expand Down

0 comments on commit a544961

Please sign in to comment.