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: