CONTRIBUTING.md

• Contributing
• About Visual Code (VSCode)

Contributing

• Install the follow packages: git.
• [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 git@github.com:aeciopires/learning-gcp-ace.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 main branch. See this tutorial
• Update the content with the suggestions of the reviewer (if necessary).
• After your pull request is merged to the main branch, 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:

• https://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow/

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:

• gitlens: https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens (require git package)
• 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

Theme for VSCode:

• https://code.visualstudio.com/docs/getstarted/themes
• https://dev.to/thegeoffstevens/50-vs-code-themes-for-2020-45cc
• https://vscodethemes.com/