mindol1004/getting-started
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update PR checklist and README

Browse Source
This commit is contained in:
Tom Hombergs
2020-07-26 09:43:22 +10:00
parent 68c676fc7f
commit 44fe1a4945
2 changed files with 4 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -5,17 +5,4 @@
This repo contains example projects which show how to use different (not only) Java technologies.
The examples are usually accompanied by a blog post on [https://reflectoring.io](https://reflectoring.io).
See the READMEs in each subdirectory of this repo for more information on each module.
## Java Modules
All Java modules require **Java 11** to compile and run.
### Building with Gradle
Each module should be an independent build and can be built by calling `./gradlew clean build` in the module directory.
All modules are listed in [build-all.sh](build-all.sh) to run in the CI pipeline.
### Non-Java Modules
Some folders contain non-Java projects. For those, refer to the README within the module folder.
See the READMEs in each subdirectory of this repo for more information on each module.

4
pull_request_template.md
View File

@@ -5,7 +5,9 @@ Please review the changes you did in this PR and check these points to make sure
- [ ] the PR doesn't contain any other files that are irrelevant to the topic of the article
- [ ] the PR contains a README.md file that explains in a sentence or two what the code example is about and links to the article on reflectoring.io (if you added to an existing module, please add the link to the existing README.md file)
- [ ] the code is covered with tests where it makes sense
- [ ] if you have created a new Maven or Gradle module, please add it to the CI build (search for "# ADD NEW MODULES HERE" in `build-all.sh`)
- [ ] if you have created a new Maven or Gradle module, please add it to the CI build (search for "# ADD NEW MODULES HERE" in `build-all.sh`)
- [ ] used the latest Gradle or Maven version
- [ ] used Java 11 or later
- [ ] the [GitHub Actions build](https://github.com/thombergs/code-examples/actions?query=workflow%3ACI) is successful for your PR branch
**Feel free to raise the PR even if the checklist hasn't been worked through, yet**. But please only flag it to be reviewed after going through the checklist above.