How shubhdhungana/bug_bounty_checklist works
Project type and purpose
• This is a _documentation/cheatsheet_ repository (no executable code), focused on bug-bounty notes, checklists, and resources.
• Purpose: serve as a centralized knowledge base of markdown and PDF cheat-sheets for security researchers.
File structure
• Top-level: a README.md, multiple folders grouping topics (e.g., “Holy Tips Checklist”, “HowToHunt”, “OWASP checklists”).
• No src/, no backend or frontend code — purely content files.
• No CI config or build scripts present (you may add a static-site generator or CI workflow later).
README for additional insights
• Confirms it’s a curated set of notes/cheatsheets.
• Mentions cloning the repo and navigating the organized folders.
• Encourages contributions via pull requests.
Main components to display
a. Content Repository (GitHub)
• Stores all markdown and PDF files in a Git repository.
b. Contributor Workstation (Local Dev)
• Users clone/fork, edit content, open pull requests.
c. Collaboration Platform (GitHub Interface)
• Pull-request workflow, issues, reviews.
d. (Optional) Continuous Integration / Build Service
• If a static-site generator (e.g., Jekyll) is added, a CI job builds HTML.
e. Static Hosting (GitHub Pages or alternative)
• Serves generated site or raw files over HTTPS.
f. End Users (Consumers)
• Bug bounty hunters accessing docs via browser or cloning locally.
Relationships and interactions
• Contributor edits on local → commits → pushes to GitHub Repo
• GitHub triggers CI (optional) → builds static site
• Built site deployed to Hosting (GitHub Pages)
• End Users access hosting over HTTPS
• End Users may also clone/fork repo directly
Architectural patterns and design principles
• _Separation of concerns_: content vs. hosting vs. user access
• _Git-centric collaboration_: version control drives updates
• _Optional automation_: a CI/CD pipeline for a static-site generator
Relevant technologies and frameworks
• Git & GitHub
• Markdown / PDF viewers
• (Optional) Jekyll, Hugo, or other static-site generators
• (Optional) GitHub Actions or external CI for builds