Skip to content

Commit 62059e4

Browse files
Apply suggestions from code review
Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>
1 parent 5cb9896 commit 62059e4

1 file changed

Lines changed: 7 additions & 8 deletions

File tree

content/developers/overview/secret-scanning.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ versions:
1313

1414
When a match of your secret format is found in a public repository, a payload is sent to an HTTP endpoint of your choice.
1515

16-
When a match of your secret format is found in a private repository configured for {% data variables.product.prodname_secret_scanning %}, then repository admins are alerted and can view and manage the {% data variables.product.prodname_secret_scanning %} results on {% data variables.product.prodname_dotcom %}. For more information, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)".
16+
When a match of your secret format is found in a private repository configured for {% data variables.product.prodname_secret_scanning %}, then repository admins are alerted and can view and manage the {% data variables.product.prodname_secret_scanning %} results on {% data variables.product.prodname_dotcom %}. For more information, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)."
1717

1818
{% note %}
1919

@@ -42,7 +42,7 @@ The following diagram summarizes the {% data variables.product.prodname_secret_s
4242

4343
#### Contact {% data variables.product.prodname_dotcom %} to get the process started
4444

45-
To get the enrollment process started, email secret-scanning@github.com.
45+
To get the enrollment process started, email <a href="mailto:secret-scanning@github.com">secret-scanning@github.com</a>.
4646

4747
You will receive details on the {% data variables.product.prodname_secret_scanning %} program, and you will need to agree to {% data variables.product.prodname_dotcom %}'s terms of participation before proceeding.
4848

@@ -284,11 +284,11 @@ For {% data variables.product.prodname_secret_scanning %} in public repositories
284284

285285
#### Provide feedback for false positives
286286

287-
We collect feedback on the validity of the detected individual secrets in partner responses. Email us at secret-scanning@github.com if you wish to to take part, and get feedback collection enabled.
287+
We collect feedback on the validity of the detected individual secrets in partner responses. If you wish to take part, email us at <a href="mailto:secret-scanning@github.com">secret-scanning@github.com</a>.
288288

289-
When we report secrets to you, we send a JSON array with each element containing the token, type identifier, and commit URL. When you send us feedback, you send us information about whether the detected token was a real or false credential.
289+
When we report secrets to you, we send a JSON array with each element containing the token, type identifier, and commit URL. When you send us feedback, you send us information about whether the detected token was a real or false credential. We accept feedback in the following formats.
290290

291-
You can find below the two response formats that we support in terms of feedback:
291+
You can send us the raw token:
292292

293293
```
294294
[
@@ -304,7 +304,7 @@ You may also provide the token in hashed form after performing a one way cryptog
304304
```
305305
[
306306
{
307-
"token_hash": "The SHA 256 hashed form of the raw token",
307+
"token_hash": "The SHA-256 hashed form of the raw token",
308308
"token_type": "ACompany_API_token",
309309
"label": "false_positive"
310310
}
@@ -317,8 +317,7 @@ A few important points:
317317

318318
{% note %}
319319

320-
**Note:** Our request timeout is set to be higher (that is, 30 seconds) for responding partners with false positives data. If you require a timeout larger than 30 seconds, email us at secret-scanning@github.com.
320+
**Note:** Our request timeout is set to be higher (that is, 30 seconds) for partners who provide data about false positives. If you require a timeout higher than 30 seconds, email us at <a href="mailto:secret-scanning@github.com">secret-scanning@github.com</a>.
321321

322322
{% endnote %}
323323

324-

0 commit comments

Comments
 (0)