trufflesecurity/trufflehog

Create table of contents for README.

Open

#2,983 opened on Jun 18, 2024

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)Go (2,397 forks)batch import
contributions welcomedgood first issuehelp wanted

Repository metrics

Stars
 (26,285 stars)
PR merge metrics
 (Avg merge 28d 2h) (41 merged PRs in 30d)

Description

I would be privileged to contribute a table of contents to this amazing project's README, to allow for easier navigation. I think this would also be a good first issue.

Contributor guide

Research direction
Add a table of contents with links to section headings using markdown anchors. Ensure the links are updated if sections are renamed.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90