Skip to content

Latest commit

 

History

History
135 lines (98 loc) · 4.41 KB

CONTRIBUTING.md

File metadata and controls

135 lines (98 loc) · 4.41 KB
Raw

Contributing

  • Have the make command and docker installed on your system. With this, you don't need the below mentioned helm and helm-docs and use containers for the needed steps instead.
  • [OPTIONAL] Install the follow packages: git, kubectl, helm, helm-docs. See this tutorial.
  • [OPTIONAL] Configure authentication on your Github account to use the SSH protocol instead of HTTP. Watch this tutorial to learn how to set up: https://help.github.com/en/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account
  • Create a fork this repository.
  • Clone the forked repository to your local system:
git clone URL_FORKED_REPOSITORY
  • Add the address for the remote original repository:
git remote -v
git remote add upstream https://github.com/zabbix-community/helm-zabbix
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.
  • Verify your changed do not introduce syntactical/semantic errors:

Method using make and docker:

cd charts/zabbix
make lint

Method using locally installed helm command:

cd charts/zabbix
helm lint .
  • Run command helm-docs to update content of README.md file using the README.md.gotmpl template. More info about helm-docs.

Method using make and docker:

cd charts/zabbix
make gen-docs

Method using locally installed helm-docs command:

cd charts/zabbix
helm-docs
  • 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 develop branch. See this tutorial
  • Update the content with the suggestions of the reviewer (if necessary).
  • After your pull request is merged to the develop and master branches, 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:

About Visual Code (VSCode)

Use a IDE (Integrated Development Environment) or text editor of your choice. By default, the use of VSCode is recommended.

VSCode (https://code.visualstudio.com), combined with the following plugins, helps the editing/review process, mainly allowing the preview of the content before the commit, analyzing the Markdown syntax and generating the automatic summary, as the section titles are created/changed.

Plugins to Visual Code:

Theme for VSCode: