Skip to content

Commit d9be2ed

Browse files
authored
Merge pull request contributor-assistant#66 from AndrewGable/andrew-fix-docs
Fix documentation in two spots
2 parents e1ed947 + f9f43ce commit d9be2ed

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ jobs:
3939
PERSONAL_ACCESS_TOKEN : ${{ secrets.PERSONAL_ACCESS_TOKEN }}
4040
with:
4141
path-to-signatures: 'signatures/version1/cla.json'
42-
path-to-cla-document: 'https://github.com/cla-assistant/github-action/blob/master/SAPCLA.md' # e.g. a CLA or a DCO document
42+
path-to-document: 'https://github.com/cla-assistant/github-action/blob/master/SAPCLA.md' # e.g. a CLA or a DCO document
4343
# branch should not be protected
4444
branch: 'master'
4545
allowlist: user1,bot*
@@ -93,17 +93,17 @@ If a GitHub username is included in the allowlist, they will not be required to
9393

9494
| Name | Requirement | Description | Example |
9595
| --------------------- | ----------- | ----------- | ------- |
96-
| `path-to-cla-document` | _required_ | provide full URL `https://<clafile>` to the document which shall be signed by the contributor(s) It can be any file e.g. inside the repository or it can be a gist. | https://github.com/cla-assistant/github-action/blob/master/SAPCLA.md |
96+
| `path-to-document` | _required_ | provide full URL `https://<clafile>` to the document which shall be signed by the contributor(s) It can be any file e.g. inside the repository or it can be a gist. | https://github.com/cla-assistant/github-action/blob/master/SAPCLA.md |
9797
| `path-to-signatures` | _optional_ | Path to the JSON file where all the signatures of the contributors will be stored inside the repository. | signatures/version1/cla.json |
9898
| `branch` | _optional_ | Branch in which all the signatures of the contributors will be stored and Default branch is `master`. | master |
99-
| `allowlist` | _optional_ | You can specify users and bots to be [added in allowlist](https://github.com/cla-assistant/github-action#5-allowlist-users-and-bots). | user1,user2,bot* |
99+
| `allowlist` | _optional_ | You can specify users and bots to be [added in allowlist](https://github.com/cla-assistant/github-action#5-users-and-bots-in-allowlist). | user1,user2,bot* |
100100
| `remote-repository-name` | _optional_ | provide the remote repository name where all the signatures should be stored . | remote repository name |
101101
| `remote-organization-name` | _optional_ | provide the remote organization name where all the signatures should be stored. | remote organization name |
102102
| `create-file-commit-message` | _optional_ |Commit message when a new CLA file is created. | Creating file for storing CLA Signatures. |
103103
| `signed-commit-message` | _optional_ | Commit message when a new contributor signs the CLA in a Pull Request. | $contributorName has signed the CLA in $pullRequestNo |
104104
| `custom-notsigned-prcomment` | _optional_ | Introductory Pull Request comment to ask new contributors to sign. | Thank you for your contribution and please kindly read and sign our $pathToCLADocument |
105105
| `custom-pr-sign-comment` | _optional_ | The signature to be committed in order to sign the CLA. | I have read the Developer Terms Document and I hereby accept the Terms |
106-
| ` custom-allsigned-prcomment` | _optional_ | pull request comment when everyone has signed | All Contributors have signed the CLA. |
106+
| `custom-allsigned-prcomment` | _optional_ | pull request comment when everyone has signed | All Contributors have signed the CLA. |
107107

108108
## License
109109

0 commit comments

Comments
 (0)