Skip to content
This repository has been archived by the owner on Mar 14, 2024. It is now read-only.

Latest commit

 

History

History
69 lines (47 loc) · 3.1 KB

CONTRIBUTING_DCO.md

File metadata and controls

69 lines (47 loc) · 3.1 KB
Raw

Contributing to service-level-indicator-exporter-for-kafka

We welcome contributions from the community and first want to thank you for taking the time to contribute!

Please familiarize yourself with the Code of Conduct before contributing.

Before you start working with service-level-indicator-exporter-for-kafka, please read our Developer Certificate of Origin. All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch.

Ways to contribute

We welcome many different types of contributions and not all of them need a Pull request. Contributions may include:

  • New features and proposals
  • Documentation
  • Bug fixes
  • Issue Triage
  • Answering questions and giving feedback
  • Helping to onboard new contributors
  • Other related activities

Getting started

The repo provide a makefile with some useful instruccion. You can start a kafka cluster with zookeeper using the docker-compose file in this project. This will deploy a simple local cluster in which you can test your service.

    make start-environ

Run kafka monitoring instance

Once you have the kafka cluster up and running you can start your kafka-monitoring instance and take a look on the metrics.

    make run-producer

Nevertheless, you can build the service and run the binary. Next command will generate a binary in bin/vdp-kafka-monitoring who you can run locally.

    make run-binary

Contribution Flow

This is a rough outline of what a contributor's workflow looks like:

  • Make a fork of the repository within your GitHub account
  • Create a topic branch in your fork from where you want to base your work
  • Make commits of logical units
  • Make sure your commit messages are with the proper format, quality and descriptiveness (see below)
  • Push your changes to the topic branch in your fork
  • Create a pull request containing that commit

We follow the GitHub workflow and you can find more details on the GitHub flow documentation.

Pull Request Checklist

Before submitting your pull request, we advise you to use the following:

  1. Check if your code changes will pass both code linting checks and unit tests.
  2. Ensure your commit messages are descriptive. We follow the conventions on How to Write a Git Commit Message. Be sure to include any related GitHub issue references in the commit message. See GFM syntax for referencing issues and commits.
  3. Check the commits and commits messages and ensure they are free from typos.

Reporting Bugs and Creating Issues

When opening a new issue, try to roughly follow the commit message/pull request format conventions above.

Ask for Help

The best way to reach us with a question when contributing is to ask on:

  • The original GitHub issue
  • The developer mailing list