sloria/sphinx-issues

support GitHub security advisory links

Open

#128 opened on Jan 31, 2023

View on GitHubContributor guide
 (5 comments) (0 reactions) (0 assignees)Python (15 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (60 stars)
PR merge metrics
 (PR metrics pending)

Description

GitHub is adding the ability to handle security reports and fixes privately in their UI. Instead of creating an issue, the reporter creates a security advisory, and then GitHub allows discussing and handles creating a private fork with private PRs until the advisory is published publicly. It would be nice to be able to reference the advisory page just like we can reference issue pages.

:ghsa:`ab1c-2def-g34h`

would become:

https://github.com/my/project/security/advisories/GHSA-ab1c-2def-g34h

Contributor guide

Research direction
Examine the existing role implementation (e.g., ':issue:') and replicate the pattern for a new ':ghsa:' role, generating the correct GitHub security advisory URL.
Tech stack
python
Domain
documentationtooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70