Skip to content

Latest commit

 

History

History
184 lines (131 loc) · 11.4 KB

CONTRIBUTING.md

File metadata and controls

184 lines (131 loc) · 11.4 KB
Raw

Contributing to KEDA

Thanks for helping make KEDA better 😍.

There are many areas we can use contributions - ranging from code, documentation, feature proposals, issue triage, samples, and content creation.

Table of contents

Project governance

You can learn about the governance of KEDA here.

Getting Help

If you have a question about KEDA or how best to contribute, the #KEDA channel on the Kubernetes slack channel (get an invite if you don't have one already) is a good place to start. We also have regular community stand-ups to track ongoing work and discuss areas of contribution. For any issues with the product you can create an issue in this repo.

Making Breaking Changes

All contributions must follow our deprecation breaking changes policy.

Contributing Scalers

One of the easiest ways to contribute is adding scalers. Scalers are the logic on when to activate a container (scaling from zero to one) and also how to serve metrics for an event source. You can view the code for existing scalers here. When writing a scaler, please consider:

  1. Is this an event source that many others will access from Kubernetes? If not, potentially consider creating an external scaler.
  2. Provide tests
  3. Provide documentation and examples for keda.sh

Information on how scalers work can be found in CREATE-NEW-SCALER and read our scaler governance policy.

Testing

It is mandatory to provide end-to-end (e2e) tests for new scaler. For more information on e2e testing in KEDA check the test documentation. Those tests are run nightly on our CI system.

Contributing webhooks

Another easy way to contribute is improving the validations to avoid misconfigurations. New rules can be added in the proper type's webhooks file (apis/keda/v1alpha1/*_webhook.go).

Metrics and Logging

Metrics

Incorporating Prometheus and OpenTelemetry metrics is essential in our project. When creating metrics, please consider the following guidelines:

  • Always specify the unit in the metric name using standard units (e.g., use seconds instead of milliseconds, bytes instead of megabytes, etc.).
  • Choose descriptive metric names. Instead of vague names like message_number or triggers, opt for more specific ones like queued_messages and trigger_registered.
  • Ensure consistency in metric naming. Review existing metrics for their naming patterns and try to align new metrics accordingly.
  • Utilize labels for differentiating metric states. Instead of creating separate metrics like messages_sent_successfully and messages_sent_failed, create a single metric messages_sent and differentiate using a label state with values success or failed.
  • Avoid overly detailed metrics. Refrain from using labels with high cardinality (such as email, message-id, or time), as this can burden the system.
  • Favor metrics that are cumulative counters. Users can then apply functions like rate() to calculate changes over time. Append total for Prometheus and count for OpenTelemetry metrics.
  • Provide clear descriptions. This should tell end-users what the metrics represent, without being a KEDA expert nor technical person.

For further guidance on metric naming and labeling, refer to the recommendations in the Prometheus and OpenTelemetry documentation.

Logging and Log Messages

When adding log messages to the project, it's crucial to set the appropriate log level and tailor the message for its intended audience:

  • Use debug level for KEDA project developers, who possess deep knowledge of the system's inner workings. Messages should be data-rich and detailed. In the code a debug message is written via verbosity level 1 on the Info() method on the logger, eg. logger.V(1).Info(msg).
  • Set to info level for engineers familiar with KEDA's components but not its intricate details. These messages should serve as updates or milestones regarding the system's sub-components, essentially acting as a status report. In the code an info message is written via Info() method on the logger, eg. logger.Info(msg).
  • Warning level and above is aimed at operational teams. Messages should be clear, concise, and either indicate consequences or be actionable, with suggestions for next steps. It indicates a problem which should be addressed in the near future if it persists. The message should contain at least the consequence. Include links to further documentation where possible. In the code a warning is written via the Info() method on the logger with a "Warning:" prefix in the message, eg. logger.Info("Warning: ...msg").
  • An error indicates a failure, and a part of the system is not capable of fulfilling its intended purpose. An error should contain what part failed, why, and possible solutions. In the code an error is usually written via the Error() method on the logger, eg. logger.Error(err, msg).

Legacy

Some of the metrics and log messages in the project don't follow the above practices, but are there for historical reasons. When refactoring pieces of code, please try to apply the best practices to any log message or metric which is impacted.

Changelog

Every change should be added to our changelog under Unreleased which is located in CHANGELOG.md. This helps us keep track of all changes in a given release.

Here are some guidelines to follow:

  • Always use General: or <Scaler Name>: as a prefix and sort them alphabetically
    • General changes, however, should always be at the top
  • Entries should always follow the <Scaler Name / General>: <Description> (#<ID>) where <ID> is preferrably the ID of an issue, otherwise a PR is OK.
  • New scalers should use General: and use this template: **General:** Introduce new XXXXXX Scaler ([#ISSUE](https://github.com/kedacore/keda/issues/ISSUE))

Including Documentation Changes

For any contribution you make that impacts the behavior or experience of KEDA, please open a corresponding docs request for keda.sh through https://github.com/kedacore/keda-docs. Contributions that do not include documentation or samples will be rejected.

Creating and building a local environment

Details on setup of a development environment are found on the README

Developer Certificate of Origin: Signing your work

Every commit needs to be signed

The Developer Certificate of Origin (DCO) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. Here is the full text of the DCO, reformatted for readability:

By making a contribution to this project, I certify that:

    (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

    (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

    (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

    (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

Contributors sign-off that they adhere to these requirements by adding a Signed-off-by line to commit messages.

This is my commit message

Signed-off-by: Random J Developer <random@developer.example.org>

Git even has a -s command line option to append this automatically to your commit message:

$ git commit -s -m 'This is my commit message'

Each Pull Request is checked whether or not commits in a Pull Request do contain a valid Signed-off-by line.

I didn't sign my commit, now what?!

No worries - You can easily replay your changes, sign them and force push them!

git checkout <branch-name>
git reset $(git merge-base main <branch-name>)
git add -A
git commit -sm "one commit on <branch-name>"
git push --force

Code Quality

This project is using pre-commits to ensure the quality of the code. We encourage you to use pre-commits, but it's not a required to contribute. Every change is checked on CI and if it does not pass the tests it cannot be accepted. If you want to check locally then you should install Python3.6 or newer together and run:

pip install pre-commit
# or
brew install pre-commit

For more installation options visit the pre-commits.

Before running pre-commit, you must install the golangci-lint tool as a static check tool for golang code (contains a series of linter)

curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.54.2
# or
brew install golangci/tap/golangci-lint

For more installation options visit the golangci-lint.

To turn on pre-commit checks for commit operations in git, run:

pre-commit install

To run all checks on your staged files, run:

pre-commit run

To run all checks on all files, run:

pre-commit run --all-files