-
Install the following packages:
gitand a 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.
-
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
When someone wants to contribute to improvements in this repository, the following steps must be performed.
- Clone the repository to your computer, with the following command:
git clone [email protected]:Sensedia/open-tools.git- Create a branch using the following command:
git checkout -b BRANCH_NAME- Make sure it is the correct branch, using the following command:
git branch- The branch with an '*' before the name will be used.
- Make the necessary changes.
- Test your changes.
- Commit your changes to the newly created branch.
- Submit the commits to the remote repository with the following command:
git push --set-upstream origin BRANCH_NAME- Create a Pull Request (PR) for the
masterbranch of the repository. Watch this tutorial. - Update the content with the reviewers suggestions (if necessary).
- After your PR has been approved and merged, update the changes in your local repository with the following commands:
git checkout master
git pull upstream master- Remove the local branch after approval and merge from your PR, using the following command:
git branch -d BRANCH_NAMEReference: