Skip to content

Commit e1afe16

Browse files
authored
Hack week 2025: fix remaining "list capitalization" warnings excluding site-policy (#53924)
1 parent c86be62 commit e1afe16

File tree

8 files changed

+33
-33
lines changed

8 files changed

+33
-33
lines changed

content/code-security/code-scanning/troubleshooting-code-scanning/resource-not-accessible.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ For more information about editing the {% data variables.product.prodname_codeql
5757
5858
If the {% data variables.code-scanning.codeql_workflow %} still fails on a commit made on the default branch, you need to check:
5959
60-
* whether {% data variables.product.prodname_dependabot %} authored the commit
61-
* whether the pull request that includes the commit has been merged using `@dependabot squash and merge`
60+
* Whether {% data variables.product.prodname_dependabot %} authored the commit
61+
* Whether the pull request that includes the commit has been merged using `@dependabot squash and merge`
6262

6363
This type of merge commit is authored by {% data variables.product.prodname_dependabot %} and therefore, any workflows running on the commit will have read-only permissions. If you enabled {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_dependabot %} security updates or version updates on your repository, we recommend you avoid using the {% data variables.product.prodname_dependabot %} `@dependabot squash and merge` command. Instead, you can enable auto-merge for your repository. This means that pull requests will be automatically merged when all required reviews are met and status checks have passed. For more information about enabling auto-merge, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request#enabling-auto-merge).

content/code-security/code-scanning/troubleshooting-sarif-uploads/file-too-large.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ There are many potential causes of very large SARIF results files.
4040

4141
Take a look at the results file that was rejected by {% data variables.product.prodname_code_scanning %} to see if:
4242

43-
* the SARIF file was compressed using gzip
44-
* the compressed file is smaller than 10 MB
43+
* The SARIF file was compressed using gzip
44+
* The compressed file is smaller than 10 MB
4545

4646
If the file wasn't compressed using gzip, try compressing the file before rerunning the upload process. If the compressed file is still too large, you need to configure the analysis to generate a smaller set of results.
4747

content/code-security/dependabot/working-with-dependabot/dependabot-options-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ For most package managers, you should define a value that will match the depende
282282

283283
Use to ignore specific versions or ranges of versions. If you want to define a range, use the standard pattern for the package manager. For example:
284284

285-
* npm: use `^1.0.0`
285+
* npm: use `^1.0.0` <!-- markdownlint-disable-line GHD034 -->
286286
* Bundler: use `~> 2.0`
287287
* Docker: use Ruby version syntax
288288
* NuGet: use `7.*`

content/packages/learn-github-packages/about-permissions-for-github-packages.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The following {% data variables.product.prodname_registry %} registries support
1919

2020
* {% data variables.product.prodname_container_registry %}
2121
{%- ifversion packages-npm-v2 %}
22-
* npm registry
22+
* npm registry <!-- markdownlint-disable-line GHD034 -->
2323
{%- endif %}
2424
{%- ifversion packages-nuget-v2 %}
2525
* NuGet registry
@@ -38,7 +38,7 @@ The following {% data variables.product.prodname_registry %} registries **only**
3838
* Docker registry (`docker.pkg.github.com`)
3939
{%- endif %}
4040
{%- ifversion packages-npm-v2 %}{% else %}
41-
* npm registry
41+
* npm registry <!-- markdownlint-disable-line GHD034 -->
4242
{%- endif %}
4343
* Apache Maven registry
4444
* Gradle registry

content/webhooks/using-webhooks/delivering-webhooks-to-private-systems.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ You may want to deliver {% data variables.product.company_short %} webhooks to p
1414

1515
A reverse proxy is a web server that sits between a client and an application. The reverse proxy receives requests from the client and forwards them to the application. This ensures no direct communication occurs between clients on the internet and the underlying application. A variety of systems can serve a reverse proxy, including:
1616

17-
* web servers, like [nginx](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/)
17+
* Web servers, like [nginx](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/)
1818
* API gateways
19-
* free, open-source overlay networks, like [OpenZiti](https://openziti.io)
20-
* commercial ingress management tools, like [ngrok](https://ngrok.com/partners/github)
21-
* free, open-source ingress management tools, like [zrok](https://zrok.io)
19+
* Free, open-source overlay networks, like [OpenZiti](https://openziti.io)
20+
* Commercial ingress management tools, like [ngrok](https://ngrok.com/partners/github)
21+
* Free, open-source ingress management tools, like [zrok](https://zrok.io)
2222

2323
How you configure your reverse proxy varies based on the system you're using.
2424

content/webhooks/using-webhooks/validating-webhook-deliveries.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ You can use the following `secret` and `payload` values to verify that your impl
6262

6363
If your implementation is correct, the signatures that you generate should match the following signature values:
6464

65-
* signature: `757107ea0eb2509fc211221cce984b8a37570b6d7586c22c46f4379c8b043e17`
65+
* signature: `757107ea0eb2509fc211221cce984b8a37570b6d7586c22c46f4379c8b043e17` <!-- markdownlint-disable-line GHD034 -->
6666
* X-Hub-Signature-256: `sha256=757107ea0eb2509fc211221cce984b8a37570b6d7586c22c46f4379c8b043e17`
6767

6868
### Examples
@@ -182,12 +182,12 @@ const webhooks = new Webhooks({
182182
const handleWebhook = async (req, res) => {
183183
const signature = req.headers["x-hub-signature-256"];
184184
const body = await req.text();
185-
185+
186186
if (!(await webhooks.verify(body, signature))) {
187187
res.status(401).send("Unauthorized");
188188
return;
189189
}
190-
190+
191191
// The rest of your logic here
192192
};
193193
```

data/reusables/rest-api/about-api-versions.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,23 @@ The {% data variables.product.product_name %} REST API is versioned. The API ver
22

33
Any breaking changes will be released in a new API version. Breaking changes are changes that can potentially break an integration. Breaking changes include:
44

5-
* removing an entire operation
6-
* removing or renaming a parameter
7-
* removing or renaming a response field
8-
* adding a new required parameter
9-
* making a previously optional parameter required
10-
* changing the type of a parameter or response field
11-
* removing enum values
12-
* adding a new validation rule to an existing parameter
13-
* changing authentication or authorization requirements
5+
* Removing an entire operation
6+
* Removing or renaming a parameter
7+
* Removing or renaming a response field
8+
* Adding a new required parameter
9+
* Making a previously optional parameter required
10+
* Changing the type of a parameter or response field
11+
* Removing enum values
12+
* Adding a new validation rule to an existing parameter
13+
* Changing authentication or authorization requirements
1414

1515
Any additive (non-breaking) changes will be available in all supported API versions. Additive changes are changes that should not break an integration. Additive changes include:
1616

17-
* adding an operation
18-
* adding an optional parameter
19-
* adding an optional request header
20-
* adding a response field
21-
* adding a response header
22-
* adding enum values
17+
* Adding an operation
18+
* Adding an optional parameter
19+
* Adding an optional request header
20+
* Adding a response field
21+
* Adding a response header
22+
* Adding enum values
2323

2424
When a new REST API version is released, the previous API version will be supported for at least 24 more months following the release of the new API version.
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
For questions, bug reports, and discussions about {% data variables.product.prodname_github_apps %}, {% data variables.product.prodname_oauth_apps %}, and API development, explore the {% data reusables.support.prodname_support_forum_with_url %}. The discussions are moderated and maintained by {% data variables.product.company_short %} staff, and answered by the {% data variables.product.company_short %} community.
22

33
Consider reaching out to [GitHub Support](https://support.github.com/) directly using the contact form for:
4-
* guaranteed response from {% data variables.product.product_name %} staff
5-
* support requests involving sensitive data or private concerns
6-
* feature requests
7-
* feedback about {% data variables.product.product_name %} products
4+
* Guaranteed response from {% data variables.product.product_name %} staff
5+
* Support requests involving sensitive data or private concerns
6+
* Feature requests
7+
* Feedback about {% data variables.product.product_name %} products

0 commit comments

Comments
 (0)