Skip to content

Commit dde3c0a

Browse files
author
Carlos Rodríguez Hernández
authored
Update CONTRIBUTING.md
Signed-off-by: Carlos Rodríguez Hernández <[email protected]>
1 parent 1505c7e commit dde3c0a

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

CONTRIBUTING.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,15 @@
22

33
Contributions are welcome via GitHub Pull Requests. This document outlines the process to help get your contribution accepted.
44

5-
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).
5+
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).
66

77
## How to Contribute
88

99
1. Fork this repository, develop, and test your changes.
1010
2. Submit a pull request.
1111

12-
***NOTE***: To make the Pull Requests' (PRs) testing and merging process easier, please submit changes to multiple charts in separate PRs.
12+
>[!NOTE]
13+
> To make the Pull Requests' (PRs) testing and merging process easier, please submit changes to multiple charts in separate PRs.
1314
1415
### Technical Requirements
1516

@@ -29,7 +30,7 @@ SPDX-License-Identifier: APACHE-2.0
2930

3031
#### Sign Your Work
3132

32-
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/).
33+
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/).
3334

3435
Then you just add a line to every git commit message:
3536

@@ -67,7 +68,8 @@ Notice the `Author` and `Signed-off-by` lines match. If they don't your PR will
6768
3. When the PR passes all tests, the PR is merged by the reviewer(s) in the GitHub `main` branch.
6869
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.
6970

70-
***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.
71+
> [!NOTE]
72+
> 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.
7173
7274
### Testing
7375

@@ -80,7 +82,7 @@ Notice the `Author` and `Signed-off-by` lines match. If they don't your PR will
8082

8183
There are five major technical requirements to add a new Helm chart to our catalog:
8284

83-
- 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.
85+
- 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.
8486
- 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.
8587
- Use an [OSI approved license](https://opensource.org/licenses) for all the software.
8688
- Every new Helm template must include a license header like the following:
@@ -92,11 +94,11 @@ SPDX-License-Identifier: APACHE-2.0
9294
*/}}
9395
```
9496

95-
- The exception to the license header rule above are `Chart.yaml` and `values.yaml` files, that use the following format instead:
97+
- The exception to the license header rule above is `Chart.yaml` and `values.yaml` files, which use the following format instead:
9698

9799
```yaml
98100
# Copyright Broadcom, Inc. All Rights Reserved.
99101
# SPDX-License-Identifier: APACHE-2.0
100102
```
101103

102-
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.
104+
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.

0 commit comments

Comments
 (0)