From b97d077be5574c04d8fb9ca89118cd7a75bd06f7 Mon Sep 17 00:00:00 2001 From: Marcus Date: Thu, 4 Apr 2024 16:10:02 +0200 Subject: [PATCH 1/2] Update readme.md added clarification on the documented links --- api/readme.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/api/readme.md b/api/readme.md index f6c7bce..6ab6a56 100644 --- a/api/readme.md +++ b/api/readme.md @@ -10,4 +10,7 @@ npx @redocly/cli build-docs toip-tswg-trustregistryprotocol-v2.yaml --output ../ NOTE: the `--output` switch is required as SpecUp only takes content from the `./docs` folder (and below). -That produces the [Redoc Rendered OpenAPI Spec](redoc-static.html) \ No newline at end of file +That produces the [Redoc Rendered OpenAPI Spec](redoc-static.html) (NOTE: this is a local link) + +A reference to Redoc can be found [here](https://github.com/Redocly/redoc). + From da5e79454f4a8148df66b1d4556fe95d9b6a8ef0 Mon Sep 17 00:00:00 2001 From: Marcus Date: Sat, 6 Apr 2024 00:20:19 +0200 Subject: [PATCH 2/2] Update Contributing.md Added tutorial for EasyCLA --- Contributing.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/Contributing.md b/Contributing.md index a89e477..777092c 100644 --- a/Contributing.md +++ b/Contributing.md @@ -1 +1,25 @@ -# Need content \ No newline at end of file +# Contribution guide + + +## Pre-requisite of EasyCLA before Submitting Pull Requests (PR) + +In order to be able to successfully submit a pull request from your fork you need to sign with EasyCLA from Linux Foundation. +The video tutorial can be found [here, assuming you have submitted a PR without prior signing](https://youtu.be/WV9AD9QvSCY?si=RmA4Y-Ttk9weLJlE&t=1428), which would leave you stuck as in this screenshot. + + +![easycla](https://github.com/Larissa-Health/tswg-trust-registry-protocol/assets/7843228/8c711fab-32cf-42b8-8f64-ee5e9b3ab01a) + + +**Click** on the link `Please click here to be authorized` and follow the process. +You will have to login with your Linux Foundation ID (Account) or create a new one. +If you signed up with ToIP under your corporation then please select this option. +Don't worry, there won't be any changes to your membership payment status, meaning it will be still free of charge to use if you are a contributing member at ToIP. + +The process is generally quite straight forward and if you know the DocuSign-procedure, then you can fast forward the video to minute `30:36` to see the relevant action to perform if you signed EasyCLA under a corporation. + +After signing with Docusign, you will have to [connect your GitHub account with EasyCLA](https://openprofile.dev/edit/connected-accounts) (This link will get you into profile settings). + +However, the system **will not** auto generate an accepted contributing user so you will have to create one through the dashboard by adding approval criteria (screenshot below). +After you have created an identification criterium (e.g. GitHub username or email address) for yourself your PR in GitHub will automatically be submitted. + +![easycla2](https://github.com/Larissa-Health/tswg-trust-registry-protocol/assets/7843228/639ab437-d3a7-4209-8133-acc25dfeddaf)