From dde3c0aefbcacb29900bb5b620fe6dadda44ccbe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20Rodr=C3=ADguez=20Hern=C3=A1ndez?= Date: Wed, 18 Dec 2024 16:21:35 +0100 Subject: [PATCH] Update CONTRIBUTING.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Carlos Rodríguez Hernández --- CONTRIBUTING.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d4c2bfcb9f34ac..edd5abca7cc78f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,14 +2,15 @@ Contributions are welcome via GitHub Pull Requests. This document outlines the process to help get your contribution accepted. -Any type of contribution is welcome; from new features, bug fixes, [tests](#testing), documentation improvements or even [adding charts to the repository](#adding-a-new-chart-to-the-repository) (if it's viable once evaluated the feasibility). +Any type of contribution is welcome; from new features, bug fixes, [tests](#testing), documentation improvements, or even [adding charts to the repository](#adding-a-new-chart-to-the-repository) (if it's viable once evaluated the feasibility). ## How to Contribute 1. Fork this repository, develop, and test your changes. 2. Submit a pull request. -***NOTE***: To make the Pull Requests' (PRs) testing and merging process easier, please submit changes to multiple charts in separate PRs. +>[!NOTE] +> To make the Pull Requests' (PRs) testing and merging process easier, please submit changes to multiple charts in separate PRs. ### Technical Requirements @@ -29,7 +30,7 @@ SPDX-License-Identifier: APACHE-2.0 #### Sign Your Work -The sign-off is a simple line at the end of the explanation for a commit. All commits needs to be signed. Your signature certifies that you wrote the patch or otherwise have the right to contribute the material. The rules are pretty simple, you only need to certify the guidelines from [developercertificate.org](https://developercertificate.org/). +The sign-off is a simple line at the end of the explanation for a commit. All commits need to be signed. Your signature certifies that you wrote the patch or otherwise have the right to contribute the material. The rules are pretty simple, you only need to certify the guidelines from [developercertificate.org](https://developercertificate.org/). Then you just add a line to every git commit message: @@ -67,7 +68,8 @@ Notice the `Author` and `Signed-off-by` lines match. If they don't your PR will 3. When the PR passes all tests, the PR is merged by the reviewer(s) in the GitHub `main` branch. 4. Then our CI/CD system is going to push the chart to the Helm registry including the recently merged changes and also the latest images and dependencies used by the chart. The changes in the images will be also committed by the CI/CD to the GitHub repository, bumping the chart version again. -***NOTE***: Please note that, in terms of time, may be a slight difference between the appearance of the code in GitHub and the chart in the registry. +> [!NOTE] +> Please note that, in terms of time, there may be a slight difference between the appearance of the code in GitHub and the chart in the registry. ### Testing @@ -80,7 +82,7 @@ Notice the `Author` and `Signed-off-by` lines match. If they don't your PR will There are five major technical requirements to add a new Helm chart to our catalog: -- The chart should use Bitnami based container images. If they don't exist, you can [open a GitHub issue](https://github.com/bitnami/charts/issues/new/choose) and we will work together to create them. +- The chart should use Bitnami-based container images. If they don't exist, you can [open a GitHub issue](https://github.com/bitnami/charts/issues/new/choose) and we will work together to create them. - Follow the same structure/patterns that the rest of the Bitnami charts (you can find a basic scaffolding in the [`template` directory](https://github.com/bitnami/charts/tree/main/template)) and the [Best Practices for Creating Production-Ready Helm charts](https://docs.vmware.com/en/VMware-Tanzu-Application-Catalog/services/tutorials/GUID-production-ready-charts-index.html) guide. - Use an [OSI approved license](https://opensource.org/licenses) for all the software. - Every new Helm template must include a license header like the following: @@ -92,11 +94,11 @@ SPDX-License-Identifier: APACHE-2.0 */}} ``` -- The exception to the license header rule above are `Chart.yaml` and `values.yaml` files, that use the following format instead: +- The exception to the license header rule above is `Chart.yaml` and `values.yaml` files, which use the following format instead: ```yaml # Copyright Broadcom, Inc. All Rights Reserved. # SPDX-License-Identifier: APACHE-2.0 ``` -Please, note we will need to check internally and evaluate the feasibility of adding the new solution to the catalog. Due to limited resources this step could take some time. +Please, note we will need to check internally and evaluate the feasibility of adding the new solution to the catalog. Due to limited resources, this step could take some time.