Skip to content

Commit

Permalink
Merge pull request #41 from Larissa-Health/main
Browse files Browse the repository at this point in the history
Update readme.md
  • Loading branch information
andorsk authored Apr 11, 2024
2 parents 7523f90 + da5e794 commit c026148
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 2 deletions.
26 changes: 25 additions & 1 deletion Contributing.md
Original file line number Diff line number Diff line change
@@ -1 +1,25 @@
# Need content
# 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)
5 changes: 4 additions & 1 deletion api/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
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).

0 comments on commit c026148

Please sign in to comment.