trufflesecurity/trufflehog

Create table of contents for README.

Open

#2,983 opened on Jun 18, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Go (26,285 stars) (2,397 forks)batch import
contributions welcomedgood first issuehelp wanted

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

Tech stack
go
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.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Markdown syntax
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Read the current README.md file in the repository root, identify the main sections, and create a table of contents with anchor links to each section. Ensure the ToC is placed near the top of the file and follows the existing formatting style.
Create table of contents for README. · trufflesecurity/trufflehog#2983 | Good First Issue