Skip to content

Commit

Permalink
docs: Update instructions for running developer scripts (#80)
Browse files Browse the repository at this point in the history
### Motivation

The documentation has an example of running one of the developer scripts in the `scripts/` directory. The scripts are not executable, so need explicitly running with `bash`.

### Modifications

Update docs to reflect the need to run the scripts with `bash`.
  • Loading branch information
Kyle-Ye authored Jun 20, 2023
1 parent 72383b3 commit 1c07b5d
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTORS.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ needs to be listed here.

**Updating this list**

Please do not edit this file manually. It is generated using `./scripts/generate-contributors-list.sh`. If a name is misspelled or appearing multiple times: add an entry in `./.mailmap`
Please do not edit this file manually. It is generated using `bash ./scripts/generate-contributors-list.sh`. If a name is misspelled or appearing multiple times: add an entry in `./.mailmap`
2 changes: 1 addition & 1 deletion scripts/generate-contributors-list.sh
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,5 @@ cat > "$here/../CONTRIBUTORS.txt" <<- EOF
**Updating this list**
Please do not edit this file manually. It is generated using \`./scripts/generate-contributors-list.sh\`. If a name is misspelled or appearing multiple times: add an entry in \`./.mailmap\`
Please do not edit this file manually. It is generated using \`bash ./scripts/generate-contributors-list.sh\`. If a name is misspelled or appearing multiple times: add an entry in \`./.mailmap\`
EOF

0 comments on commit 1c07b5d

Please sign in to comment.