@@ -46,7 +46,7 @@ project. This document describes the contribution guidelines for the project.
46
46
[ personal access token] ( https://docs.github.com/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens )
47
47
1 . Set up your [ development environment] ( #environment-setup )
48
48
49
- ### Environment Setup
49
+ ### Environment setup
50
50
51
51
You must install these tools:
52
52
@@ -89,7 +89,7 @@ the changes made locally.
89
89
1 . Install the build tools for the project by running the command ` make install `
90
90
1 . Run the command ` make build ` to build the source code
91
91
92
- ## How to run scorecard locally
92
+ ## How to run Scorecard locally
93
93
94
94
In the project folder, run the following command:
95
95
@@ -132,7 +132,7 @@ go run main.go --repo=github.com/ossf-tests/scorecard-check-branch-protection-e2
132
132
go run main.go --repo=github.com/ossf-tests/scorecard-check-branch-protection-e2e --checks=Pinned-Dependencies,Binary-Artifacts
133
133
```
134
134
135
- ## PR Process
135
+ ## PR process
136
136
137
137
Every PR should be annotated with an icon indicating whether it's a:
138
138
@@ -175,7 +175,7 @@ While they are included in `make all`, running them individually is faster.
175
175
| ` make unit-test ` | Runs unit tests only | yes |
176
176
| ` make check-linter ` | Checks linter issues only | yes |
177
177
178
- ## Changing Score Results
178
+ ## Changing score results
179
179
180
180
As a general rule of thumb, pull requests that change Scorecard score results will need a good reason to do so to get merged.
181
181
It is a good idea to discuss such changes in a GitHub issue before implementing them.
@@ -194,12 +194,12 @@ For public repos, classic personal access tokens need the following scopes:
194
194
195
195
- ` public_repo ` - Read/write access to public repositories. Needed for branch protection
196
196
197
- ## Where the CI Tests are configured
197
+ ## Where the CI tests are configured
198
198
199
- 1 . See the [ action files] ( .github/workflows ) to check its tests, and the
199
+ 1 . See the [ action files] ( .github/workflows ) to check its tests and the
200
200
scripts used on it.
201
201
202
- ## How do I add additional GitHub repositories to be scanned by scorecard weekly?
202
+ ## How do I add additional GitHub repositories to be scanned by Scorecard weekly?
203
203
204
204
Scorecard maintains the list of GitHub repositories in a file
205
205
https://github.com/ossf/scorecard/blob/main/cron/internal/data/projects.csv
@@ -208,18 +208,18 @@ GitLab repositories are listed in:
208
208
https://github.com/ossf/scorecard/blob/main/cron/internal/data/gitlab-projects.csv
209
209
210
210
Append your desired repositories to the end of these files, then run ` make add-projects ` .
211
- Commit the changes, and submit a PR and scorecard would start scanning in subsequent runs.
211
+ Commit the changes and submit a PR and scorecard would start scanning in subsequent runs.
212
212
213
- ## Adding New Checks
213
+ ## Adding new checks
214
214
215
215
See [ checks/write.md] ( checks/write.md ) .
216
216
When you add new checks, you need to also update the docs.
217
217
218
- ## Adding New Probes
218
+ ## Adding new probes
219
219
220
220
See [ probes/README.md] ( probes/README.md ) for information about the probes.
221
221
222
- ## Updating Docs
222
+ ## Updating docs
223
223
224
224
A summary for each check needs to be included in the ` README.md ` .
225
225
In most cases, to update the documentation simply edit the corresponding
0 commit comments