Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Script to generate the contributor list has incorrect documentation #79

Closed
Kyle-Ye opened this issue Jun 20, 2023 · 0 comments · Fixed by #80
Closed

Script to generate the contributor list has incorrect documentation #79

Kyle-Ye opened this issue Jun 20, 2023 · 0 comments · Fixed by #80
Labels
area/documentation Improvements or additions to documentation. kind/bug Feature doesn't work as expected. size/S Small task. (A couple of hours of work.)

Comments

@Kyle-Ye
Copy link
Contributor

Kyle-Ye commented Jun 20, 2023

In generate-contributors-list.sh file, it is suggesting we run ./scripts/generate-contributors-list.sh to update CONTRIBUTORS.txt. However this file is not executable

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\`
➜  swift-openapi-generator git:(main) l scripts             
total 72
drwxr-xr-x  11 kyle  staff   352B  6 20 11:38 .
drwxr-xr-x@ 27 kyle  staff   864B  6 20 11:38 ..
-rw-r--r--   1 kyle  staff   1.2K  6 19 23:50 check-for-broken-symlinks.sh
-rw-r--r--   1 kyle  staff   1.3K  6 19 23:50 check-for-docc-warnings.sh
-rw-r--r--   1 kyle  staff   1.3K  6 19 23:50 check-for-unacceptable-language.sh
-rw-r--r--   1 kyle  staff   3.7K  6 20 11:38 check-license-headers.sh
-rw-r--r--   1 kyle  staff   1.9K  6 19 23:50 generate-contributors-list.sh
-rw-r--r--   1 kyle  staff   2.2K  6 19 23:50 run-integration-test.sh
-rw-r--r--   1 kyle  staff   1.5K  6 20 11:38 run-swift-format.sh
-rwxr-xr-x   1 kyle  staff   1.4K  6 19 23:50 soundness.sh
-rw-r--r--   1 kyle  staff   106B  6 19 23:50 unacceptable-language.txt

Since all the scripts file already have #! in the header, we should consider add executable permission to them by chmod +x scripts/*.sh

@czechboy0 czechboy0 added area/documentation Improvements or additions to documentation. kind/bug Feature doesn't work as expected. size/S Small task. (A couple of hours of work.) labels Jun 20, 2023
@czechboy0 czechboy0 changed the title Script permission issue Script to generate the contributor list has incorrect documentation Jun 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation. kind/bug Feature doesn't work as expected. size/S Small task. (A couple of hours of work.)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants