Skip to content

Latest commit

 

History

History
69 lines (48 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

69 lines (48 loc) · 3.09 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull Request Process

  1. Ensure any installation or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  3. Increase the version numbers in any example files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer where first three numbers represent Spring version in use and the last fourth number represents library code version.
  4. You may merge the Pull Request in once you have the sign-off of at least one other developer.

Guides

The following guides illustrate how to use some features concretely:

Reference Documentation

For further reference, please consider the following sections:

Build tools

The command typically used to build the project is:

./gradlew clean spotlessApply build

Spring

Third-party libraries

Additional test libraries

Setting up test environment

  • You need typical Spring Boot project for testing with Spring Cache / Spring Web for invoking something to trigger the cache.
  • Spin up local Redis instance by using
docker run -d --name redis -p 6379:6379 redis:7.2.4-alpine
  • Spin up Redis Insight dashboard to observe Redis state by using:
docker run -d --name redisinsight -p 5540:5540 redis/redisinsight:latest -v redisinsight:/data
  • Redis Insight woiuld be typically available at http://localhost:5540, your Redis URL to connect would typically have IP of your Docker Machine: look into Redis container network setting by running docker inspect redis (typically IP would look like 172.17.0.2 or similar).