Skip to content

Files

Latest commit

 

History

History
30 lines (21 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

30 lines (21 loc) · 1.59 KB

Contribution Guide

Component

The component is packaged as a Helm chart with special metadata added to the Chart.yaml in the form of annotations.

To propose a change to this component, first open an issue where you explain the feature you want to implement. This will help maintainers better evaluate your proposal in light of the broader roadmap for the component and advise you on how to move forward with your contribution.

When you are ready to implement your changes, fork the repository and commit your feature to your fork. Finally open a pull request from your fork to the main branch of this repository. A maintainer will review your changes and help you successfully land your contribution.

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

Thank you for contributing to this project, and welcome to the Karavel community!

Documentation

The documentation is built with mkdocs and the mkdocs-material theme.
To quickly preview changes made to the files in the docs folder, a Docker-based script is provided at hacks/mkdocs. Simply running the script will start the development server at http://localhost:8000.

platform-component-external-dns/CONTRIBUTING.md at main · karavel-io/platform-component-external-dns · GitHub