RomanNum3ral
/
Cybersecurity-Projects
mirror of https://github.com/CarterPerez-dev/Cybersecurity-Projects.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Cybersecurity-Projects/.github/PULL_REQUEST_TEMPLATE.md

1.3 KiB
Raw Permalink Blame History

Description

Provide a clear description of what this pull request does.

Type of Change

  • New project idea (SYNOPSES)
  • Full project implementation
  • Bug fix
  • Documentation improvement
  • Other (please describe)

Checklist

General:

  • My code follows the existing style and conventions
  • I have tested my changes
  • I have updated relevant documentation
  • My changes do not introduce security vulnerabilities
  • I have read the CONTRIBUTING.md guidelines

For Full Project Implementations:

  • Project includes learn/ folder with all 5 required files:
    • 00-OVERVIEW.md - Project intro and quick start
    • 01-CONCEPTS.md - Security concepts and theory
    • 02-ARCHITECTURE.md - System design and decisions
    • 03-IMPLEMENTATION.md - Code walkthrough
    • 04-CHALLENGES.md - Extension ideas
  • Educational documentation references actual code with file:line format
  • Includes real world examples (breaches, CVEs, incidents)
  • Uses ASCII diagrams where helpful
  • Follows writing guidelines in .github/learn-folder-template/README.md
  • Verified completeness with .github/learn-folder-template/CHECKLIST.md

Related Issues

Link any related issues here (e.g., "Fixes #123").

Additional Context

Any other information that reviewers should know.