-
Notifications
You must be signed in to change notification settings - Fork 64.7k
Description
Code of Conduct
- I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
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)
