From 1f7e6e1fc8d435dfd7bb4e4727100200aff493a1 Mon Sep 17 00:00:00 2001 From: Akshay Iyyadurai Balasundaram Date: Thu, 13 Feb 2020 11:01:34 +0100 Subject: [PATCH] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 300a30d..1a22011 100644 --- a/README.md +++ b/README.md @@ -45,11 +45,11 @@ jobs: #### 2. Pull Request event triggers CLA Workflow CLA action workflow will be triggered on all Pull Request `opened, synchronize, closed`. -
When the CLA workflow is triggered on pull request `closed` event, it will lock the Pull Request conversation after the Pull Request merge, so that the contributors cannot modify or delete the signatures (Pull Request comment) later. This feature is optional. +
When the CLA workflow is triggered on pull request `closed` event, it will lock the Pull Request conversation after the Pull Request merge so that the contributors cannot modify or delete the signatures (Pull Request comment) later. This feature is optional. #### 3. Signing the CLA -CLA workflow creates a comment on Pull Request asking contributors who have not signed the CLA to sign and also fails the pull request status check with a `failure`. The contributors are asked to sign the CLA within the pull request by copy and pasting **"I have read the CLA Document and I hereby sign the CLA"** as a Pull Request comment like below. -If the contributor has already signed the CLA then the PR status will pass with `success`.
By default, this Action workflow will also create an empty commit with message **"@#contributorname# has signed the CLA"** whenever a contributor signs the CLA. +CLA workflow creates a comment on Pull Request asking contributors who have not signed CLA to sign and also fails the pull request status check with a `failure`. The contributors are requested to sign the CLA within the pull request by copy and pasting **"I have read the CLA Document and I hereby sign the CLA"** as a Pull Request comment like below. +If the contributor has already signed the CLA, then the PR status will pass with `success`.
By default, this Action workflow will also create an empty commit with a message **"@#contributorname# has signed the CLA"** whenever a contributor signs the CLA. ![Screenshot 2020-02-13 at 10 24 17](https://user-images.githubusercontent.com/33329946/74420003-0ca6e780-4e4b-11ea-85a7-4ccc3f53e3d5.png) @@ -57,13 +57,13 @@ If the contributor has already signed the CLA then the PR status will pass with #### 4. Signatures stored in a JSON file -After the contributor signed a CLA, the contributor's signature with metadata will be stored in a json file inside the repository like below screenshot and you can specify the custom path to this file with `path-to-signatures` input in the workflow .
The default path is `path-to-signatures: 'signatures/version1/cla.json'` +After the contributor signed a CLA, the contributor's signature with metadata will be stored in a JSON file inside the repository like below screenshot and you can specify the custom path to this file with `path-to-signatures` input in the workflow.
The default path is `path-to-signatures: 'signatures/version1/cla.json'` ![Screenshot 2020-01-07 at 16 13 43](https://user-images.githubusercontent.com/33329946/71905595-c33aec80-3168-11ea-8a08-c78f13cb0dcb.png) #### 5. Whitelisting users and bots -If a GitHub username is included in the whitelist, they will not be required to sign a CLA. You can make use of this feature If you don't want your colleagues working in the same team/organisation to sign a CLA. And also, Since there's no way for bot users (such as Dependabot or Greenkeeper) to sign a CLA, you may want to whitelist them. You can do so by adding their names in a comma seperated string to the `whitelist` input in the CLA workflow file(in this case `dependabot-preview[bot],greenkeeper[bot]`). You can also use wildcard symbol in case you want to whitelist all bot users something like `bot*`. +If a GitHub username is included in the whitelist, they will not be required to sign a CLA. You can make use of this feature If you don't want your colleagues working in the same team/organisation to sign a CLA. And also, since there's no way for bot users (such as Dependabot or Greenkeeper) to sign a CLA, you may want to whitelist them. You can do so by adding their names in a comma separated string to the `whitelist` input in the CLA workflow file(in this case `dependabot-preview[bot],greenkeeper[bot]`). You can also use wildcard symbol in case you want to whitelist all bot users something like `bot*`. #### 6. Signatures can be additionally stored on the Ethereum Blockchain