-
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
-
[OPTIONAL] Install all packages and binaries following this tutorial.
-
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 [email protected]:Sensedia/open-tools.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 Pull Request (PR) to the
masterbranch. See this tutorial - Update the content with the suggestions of the reviewer (if necessary).
- After your pull request is merged to the
masterbranch, 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
masterbranch 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 masterReference:
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:
- docker: https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker (require docker-ce package)
- gitlens: https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens (require git package)
- go: https://marketplace.visualstudio.com/items?itemName=golang.Go (require go package)
- gotemplate-syntax: https://marketplace.visualstudio.com/items?itemName=casualjim.gotemplate
- jenkinsfile support: https://marketplace.visualstudio.com/items?itemName=ivory-lab.jenkinsfile-support
- Markdown-all-in-one: https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one
- Markdown-lint: https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint
- Markdown-toc: https://marketplace.visualstudio.com/items?itemName=AlanWalk.markdown-toc
- python: https://marketplace.visualstudio.com/items?itemName=ms-python.python (require python3 package)
- shellcheck: https://marketplace.visualstudio.com/items?itemName=timonwong.shellcheck (require shellcheck package)
- terraform: https://marketplace.visualstudio.com/items?itemName=HashiCorp.terraform (require terraform package)
- YAML: https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml
- Helm Intellisense: https://marketplace.visualstudio.com/items?itemName=Tim-Koehler.helm-intellisense
Theme for VSCode: