Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 1.75 KB

contributing.md

File metadata and controls

41 lines (28 loc) · 1.75 KB

Contributing to Authorino

Open issues

Start by checking the list of issues in GitHub. Maybe your idea was discussed in the past or is part of an ongoing conversation.

In case it is a new idea for enhancement, a bug fix, a question or whatever unprecedented contribution you want to share, before sending a pull-request, please make sure to describe the issue so we can have a conversation together and help you fin dthe best way to get your contribution merged.

Local setup

Make sure you have installed:

Then fork the repo and download the Golang dependencies:

git clone [email protected]:kuadrant/authorino.git && cd authorino
make vendor

Start contributing

  • Make your local changes
  • Sign your commits
  • Send your pull-request

Additional resources to contributors

Logging messages

A few guidelines for adding logging messages in your code:

  1. Make sure you understand Authorino's Logging architecture and policy regarding log levels, log modes, tracing IDs, etc.
  2. Respect controller-runtime's Logging Guidelines.
  3. Do not add sensitive data to your info log messages; instead, redact all sensitive data in your log messages or use debug log level by mutating the logger with V(1) before outputting the message.