Skip to content

Latest commit

 

History

History
108 lines (72 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

108 lines (72 loc) · 3.12 KB
Raw

Contributing

Configure authentication on your account to use the SSH protocol instead of HTTP. See this tutorial

  • Install the requirements.

  • Create a fork this repository.

  • Clone the forked repository to your local system:

git clone FORKED_REPOSITORY
  • Add the address for the remote original repository:
git remote -v
git remote add upstream git@github.com:aeciopires/zabbix-scripts.git
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.
  • Commit the changes to the branch.
  • Push files to repository remote with command:
git push --set-upstream origin BRANCH_NAME
  • Create a Pull Request (PR) for the main branch of the repository. Watch this tutorial.
  • Update the content with the suggestions of the reviewer (if necessary).
  • After your pull request has been approved and merged, update your local clone:
git checkout main
git pull upstream main
  • Clean up after your pull request is merged with command:
git branch -d BRANCH_NAME
  • Then you can update the main branch in your forked repository.
git push origin main
  • 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 main
git push origin main

Reference:

About 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.

Additional plugins:

Themes for VSCode: