Skip to content

Commit

Permalink
Updates README with branch creation policy
Browse files Browse the repository at this point in the history
  • Loading branch information
lucasmlp committed Apr 23, 2024
1 parent a5d7369 commit 02cd0d7
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Rancher Charts
# Rancher Charts

This repository contains Helm charts served by Rancher Apps & Marketplace.

Expand Down Expand Up @@ -31,6 +31,11 @@ All issues must be created in the [`rancher/rancher`](https://github.com/rancher

### Making Changes

General rules:
- **Fork and Clone**: Start by forking the repository and then cloning it locally to make changes in your own copy of the project.
- **Branch Naming**: Create a branch for your changes that is descriptive of the feature or fix you're working on. Do not create branches on this repository. If you feel that you absolutely need to create one, get in touch with @teamranchermapps and we'll evaluate each case individually. There is an automation in place that will remove unauthorized branches.
- **Commit Messages**: Write meaningful commit messages that describe the changes made in each commit. Check [`docs/validation.md`](docs/validation.md) for more information on commit messages.

Since this repository uses [`rancher/charts-build-scripts`](https://github.com/rancher/charts-build-scripts), making changes to this repository involves three steps:
1. Adding or modifying an existing `Package` tracked in the `packages/` directory. Usually involves `make prepare`, `make patch`, and `make clean`.
2. Running `make charts` to automatically generate assets used to serve a Helm repository (`charts/`, `assets/`, and `index.yaml`) based on the contents of `packages/`.
Expand Down

0 comments on commit 02cd0d7

Please sign in to comment.