Skip to content

Commit 4feedb8

Browse files
authored
📖 Capitalization and punctuation in CONTRIBUTING.md (#4714)
* Capitalization and punctuation in CONTRIBUTING.md Signed-off-by: Denzel Caine(He/Him) <[email protected]> * Capitalization and punctuation in CONTRIBUTING.md Co-authored-by: Kaylee Williams <[email protected]> Co-authored-by: Kailea Lee <[email protected]> Co-authored-by: Jakiya Brown <[email protected]> Co-authored-by: Devon Bobo <[email protected]> Co-authored-by: Samir Ghosh <[email protected]> Signed-off-by: Denzel Caine(He/Him) <[email protected]> --------- Signed-off-by: Denzel Caine(He/Him) <[email protected]>
1 parent ddedf1e commit 4feedb8

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ project. This document describes the contribution guidelines for the project.
4646
[personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)
4747
1. Set up your [development environment](#environment-setup)
4848

49-
### Environment Setup
49+
### Environment setup
5050

5151
You must install these tools:
5252

@@ -89,7 +89,7 @@ the changes made locally.
8989
1. Install the build tools for the project by running the command `make install`
9090
1. Run the command `make build` to build the source code
9191

92-
## How to run scorecard locally
92+
## How to run Scorecard locally
9393

9494
In the project folder, run the following command:
9595

@@ -132,7 +132,7 @@ go run main.go --repo=github.com/ossf-tests/scorecard-check-branch-protection-e2
132132
go run main.go --repo=github.com/ossf-tests/scorecard-check-branch-protection-e2e --checks=Pinned-Dependencies,Binary-Artifacts
133133
```
134134

135-
## PR Process
135+
## PR process
136136

137137
Every PR should be annotated with an icon indicating whether it's a:
138138

@@ -175,7 +175,7 @@ While they are included in `make all`, running them individually is faster.
175175
| `make unit-test` | Runs unit tests only | yes |
176176
| `make check-linter` | Checks linter issues only | yes |
177177

178-
## Changing Score Results
178+
## Changing score results
179179

180180
As a general rule of thumb, pull requests that change Scorecard score results will need a good reason to do so to get merged.
181181
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:
194194

195195
- `public_repo` - Read/write access to public repositories. Needed for branch protection
196196

197-
## Where the CI Tests are configured
197+
## Where the CI tests are configured
198198

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
200200
scripts used on it.
201201

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?
203203

204204
Scorecard maintains the list of GitHub repositories in a file
205205
https://github.com/ossf/scorecard/blob/main/cron/internal/data/projects.csv
@@ -208,18 +208,18 @@ GitLab repositories are listed in:
208208
https://github.com/ossf/scorecard/blob/main/cron/internal/data/gitlab-projects.csv
209209

210210
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.
212212

213-
## Adding New Checks
213+
## Adding new checks
214214

215215
See [checks/write.md](checks/write.md).
216216
When you add new checks, you need to also update the docs.
217217

218-
## Adding New Probes
218+
## Adding new probes
219219

220220
See [probes/README.md](probes/README.md) for information about the probes.
221221

222-
## Updating Docs
222+
## Updating docs
223223

224224
A summary for each check needs to be included in the `README.md`.
225225
In most cases, to update the documentation simply edit the corresponding

0 commit comments

Comments
 (0)