This Contributing Guide is intended for those that would like to contribute to this repository.
If you would like to use any of the published modules in your project, you can instead include the artifacts from the Maven Central repository using your build tool of choice or the published container images.
See our Contributor Code of Conduct.
Contributions come in various forms and are not limited to code changes. The community benefits from contributions in all forms.
For example, those with knowledge and experience can contribute by:
- Answering Stackoverflow questions
- Answering questions on the Micrometer slack
- Share knowledge in other ways (e.g. presentations, blogs)
The remainder of this document will focus on guidance for contributing code changes. It will help contributors to build, modify, or test the source code.
All commits must include a Signed-off-by trailer at the end of each commit message to indicate that the contributor agrees to the Developer Certificate of Origin. For additional details, please refer to the blog post Hello DCO, Goodbye CLA: Simplifying Contributions to Spring.
The source code is hosted on GitHub at https://github.com/micrometer-metrics/prometheus-rsocket-proxy. You can use a Git client to clone the source code to your local machine.
This project targets Java 17.
The Gradle wrapper is provided and should be used for building with a consistent version of Gradle.
The wrapper can be used with a command, for example, ./gradlew check to build the project and check conventions.
This repository should be imported as a Gradle project into your IDE of choice.
Specific modules or a test class can be run from your IDE for convenience.
The Gradle check task depends on the test task, and so tests will be run as part of a build as described previously.
Run ./gradlew pTML to publish a Maven-style snapshot to your Maven local repo. The build automatically calculates
the "next" version for you when publishing snapshots.
These local snapshots can be used in another project to test the changes.