VictoriaMetrics/docs/helm/CONTRIBUTING.md
Github Actions 8f5e0ebbb4
Automatic update helm docs from VictoriaMetrics/helm-charts@f0e007f ()
Automated changes by
[create-pull-request](https://github.com/peter-evans/create-pull-request)
GitHub action

Signed-off-by: Github Actions <133988544+victoriametrics-bot@users.noreply.github.com>
Co-authored-by: AndrewChubatiuk <3162380+AndrewChubatiuk@users.noreply.github.com>
2024-09-20 17:38:55 +02:00

2.1 KiB

Contributing

git clone URL_FORKED_REPOSITORY
  • Add the address for the remote original repository:
git remote -v
git remote add upstream https://github.com/VictoriaMetrics/helm-charts
git remote -v
  • Create a branch. Example:
git checkout -b BRANCH_NAME
  • Make sure you are on the correct branch using the following command. The branch in use contains the '*' before the name.
git branch
  • Make your changes and tests to the new branch.
  • Run command helm-docs to update content of README.md file of all charts using the README.md.gotmpl template.
  • Commit the changes to the branch.
  • Push files to repository remote with command:
git push --set-upstream origin BRANCH_NAME
  • Create Pull Request (PR) to the master branch. See this tutorial
  • Update the content with the suggestions of the reviewer (if necessary).
  • After your pull request is merged to the master branch, update your local clone:
git checkout master
git pull upstream master
  • Clean up after your pull request is merged with command:
git branch -d BRANCH_NAME
  • Then you can update the master branch in your forked repository.
git push origin master
  • And push the deletion of the feature branch to your GitHub repository with command:
git push --delete origin BRANCH_NAME
  • To keep your fork in sync with the original repository, use these commands:
git pull upstream master
git push origin master

Reference: