Skip to content

Document security policy being shown along with issue templates #18798

@oplik0

Description

@oplik0

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates

What part(s) of the article would you like to see updated?

Currently the docs don't seem to mention the fact that security policy is shown on the issue template chooser, and the configure section specifically has an example with a link to bug bounty:

blank_issues_enabled: false
contact_links:
  - name: GitHub Community Support
    url: https://github.amrom.workers.devmunity/
    about: Please ask and answer questions here.
  - name: GitHub Security Bug Bounty
    url: https://bounty.github.com/
    about: Please report security vulnerabilities here.

This, combined with it being quite inconvenient to test the templates due to them only working on the default branch, means it's quite possible to accidentally create a redundant contact link for security information.

As such I think it'd be a good idea to clarify that security policy will be also be shown alongside issue templates and perhaps add it to the screenshot of the issue template chooser in the article.

Additional information

An example of me adding a redundant link due to not knowing that security policy would be displayed can be seen in NodeBB repo: NodeBB/NodeBB#10720 (and the PR fixing it: NodeBB/NodeBB#10723)
example of redundant Security Issues link below the default Report a security vulnerability link to the security policy

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions