Skip to content

Commit 7809435

Browse files
[EDI] Adding a security policy to your repository (#59264)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 828f808 commit 7809435

File tree

2 files changed

+15
-24
lines changed

2 files changed

+15
-24
lines changed

content/code-security/how-tos/report-and-fix-vulnerabilities/configure-vulnerability-reporting/adding-a-security-policy-to-your-repository.md

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -20,29 +20,6 @@ topics:
2020
shortTitle: Add a security policy
2121
---
2222

23-
## About security policies
24-
25-
To give people instructions for reporting security vulnerabilities in your project, you can add a `SECURITY.md` file to your repository's root, `docs`, or `.github` folder. Adding this file to this part(s) of your repository automatically creates a row with a description where people can review it. When someone creates an issue in your repository, they will see a link to your project's security policy.
26-
27-
You can create a default security policy for your organization or personal account. For more information, see [AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file).
28-
29-
> [!TIP]
30-
> To help people find your security policy, you can link to your `SECURITY.md` file from other places in your repository, such as your `README` file. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes).
31-
32-
{% ifversion fpt or ghec %}
33-
After someone reports a security vulnerability in your project, you can use {% data variables.product.prodname_security_advisories %} to disclose, fix, and publish information about the vulnerability. For more information about the process of reporting and disclosing vulnerabilities in {% data variables.product.prodname_dotcom %}, see [AUTOTITLE](/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/about-coordinated-disclosure-of-security-vulnerabilities#about-reporting-and-disclosing-vulnerabilities-in-projects-on-github). For more information about repository security advisories, see [AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories).
34-
35-
{% data reusables.repositories.github-security-lab %}
36-
{% endif %}
37-
{% ifversion ghes %}
38-
<!-- alternative to the content about GitHub Security Advisories in the dotcom article -->
39-
By making security reporting instructions clearly available, you make it easy for your users to report any security vulnerabilities they find in your repository using your preferred communication channel.
40-
{% endif %}
41-
42-
For an example of a real `SECURITY.md` file, see [https://github.com/electron/electron/blob/main/SECURITY.md](https://github.com/electron/electron/blob/main/SECURITY.md).
43-
44-
## Adding a security policy to your repository
45-
4623
{% data reusables.repositories.navigate-to-repo %}
4724
{% data reusables.repositories.sidebar-security %}
4825
1. In the left sidebar, under "Reporting", click **{% octicon "law" aria-hidden="true" aria-label="law" %} Policy**.
@@ -55,6 +32,7 @@ For an example of a real `SECURITY.md` file, see [https://github.com/electron/el
5532

5633
## Further reading
5734

35+
* [AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)
5836
* [AUTOTITLE](/code-security/getting-started/securing-your-repository)
5937
* [AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions){% ifversion fpt or ghec %}
6038
* [{% data variables.product.prodname_security %}]({% data variables.product.prodname_security_link %}){% endif %}

content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ You can add default community health files to a **public**{% ifversion ghec or g
2626

2727
If no corresponding file is found in the current repository, {% data variables.product.github %} will use the default file from the `.github` repository, following the same order of precedence.
2828

29-
**Note:** The `.github` repository must be **public**{% ifversion ghec or ghes %} or **internal**{% endif %} for templates to be applied organization-wide. Private `.github` repositories are not supported.
29+
>[!NOTE] The `.github` repository must be **public**{% ifversion ghec or ghes %} or **internal**{% endif %} for templates to be applied organization-wide. Private `.github` repositories are not supported.
3030
3131
For example, anyone who creates an issue or pull request in a repository that does not have its own `CONTRIBUTING.md` file will see a link to the default `CONTRIBUTING.md` from the `.github` repository. However, if a repository has any files in its own `.github/ISSUE_TEMPLATE` folder, such as issue templates or a `_config.yml` file, none of the contents of the default `.github/ISSUE_TEMPLATE` folder will be used. This allows repository maintainers to override the default files with specific templates or content on per-repository basis.
3232

@@ -38,6 +38,19 @@ As a repository maintainer, you can use the community standards checklist to see
3838

3939
{% endif %}
4040

41+
## About security policies
42+
43+
{% ifversion fpt or ghec %}
44+
After someone reports a security vulnerability in your project, you can use {% data variables.product.prodname_security_advisories %} to disclose, fix, and publish information about the vulnerability. For more information about the process of reporting and disclosing vulnerabilities in {% data variables.product.prodname_dotcom %}, see [AUTOTITLE](/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/about-coordinated-disclosure-of-security-vulnerabilities#about-reporting-and-disclosing-vulnerabilities-in-projects-on-github). For more information about repository security advisories, see [AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories).
45+
{% endif %}
46+
47+
{% ifversion ghes %}
48+
<!-- alternative to the content about GitHub Security Advisories in the dotcom article -->
49+
By making security reporting instructions clearly available, you make it easy for your users to report any security vulnerabilities they find in your repository using your preferred communication channel.
50+
{% endif %}
51+
52+
For an example of a real `SECURITY.md` file, see [https://github.com/electron/electron/blob/main/SECURITY.md](https://github.com/electron/electron/blob/main/SECURITY.md).
53+
4154
## Supported file types
4255

4356
You can create defaults in your organization or personal account for the following community health files:

0 commit comments

Comments
 (0)