You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+1-72Lines changed: 1 addition & 72 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -71,17 +71,10 @@ PROJECTS/
71
71
├── beginner/
72
72
│ └── simple-port-scanner/
73
73
│ ├── README.md
74
-
│ ├── learn/
75
-
│ │ ├── 00-OVERVIEW.md
76
-
│ │ ├── 01-CONCEPTS.md
77
-
│ │ ├── 02-ARCHITECTURE.md
78
-
│ │ ├── 03-IMPLEMENTATION.md
79
-
│ │ └── 04-CHALLENGES.md
80
74
│ └── src/
81
75
├── intermediate/
82
76
│ └── oauth-token-analyzer/
83
77
│ ├── README.md
84
-
│ ├── learn/
85
78
│ ├── .env.example
86
79
│ ├── requirements.txt
87
80
│ ├── src/
@@ -92,7 +85,6 @@ PROJECTS/
92
85
└── advanced/
93
86
└── bug-bounty-platform/
94
87
├── README.md
95
-
├── learn/
96
88
├── .env.example
97
89
├── docker-compose.yml
98
90
├── backend/
@@ -101,70 +93,8 @@ PROJECTS/
101
93
└── examples/
102
94
```
103
95
104
-
### 4. Educational Documentation (learn/ Folder)
105
96
106
-
All projects must include a `learn/` directory with educational documentation. This helps users understand not just how to use your project, but how it works and what security concepts it teaches.
107
-
108
-
**Required files:**
109
-
110
-
Copy the template from `.github/learn-folder-template/` to get started:
- What users will learn (security concepts, technical skills)
124
-
- Prerequisites and quick start instructions
125
-
- Common issues and solutions
126
-
127
-
2.**01-CONCEPTS.md** - Security concepts and theory
128
-
- Core security concepts explained in depth
129
-
- Common attacks and defense strategies
130
-
- Real world examples and breaches
131
-
- Industry standards (OWASP, MITRE, CWE)
132
-
- Further reading resources
133
-
134
-
3.**02-ARCHITECTURE.md** - System design
135
-
- High level architecture diagrams
136
-
- Component breakdown and responsibilities
137
-
- Data flow examples
138
-
- Design decisions and trade-offs
139
-
- Performance and security considerations
140
-
141
-
4.**03-IMPLEMENTATION.md** - Code walkthrough
142
-
- Step by step implementation guide
143
-
- Real code from the project with file:line references
144
-
- Security implementation details
145
-
- Common pitfalls and debugging tips
146
-
- Testing and deployment
147
-
148
-
5.**04-CHALLENGES.md** - Extension ideas
149
-
- Easy to expert level challenges
150
-
- Hints without full solutions
151
-
- Real world integration ideas
152
-
- Performance and security challenges
153
-
154
-
**Quality standards:**
155
-
156
-
- Reference actual code with `filename:line` format
157
-
- Include real world examples (breaches, CVEs, incidents)
158
-
- Use ASCII diagrams for architecture and data flow
159
-
- Show common mistakes and how to avoid them
160
-
- Write in a clear, human voice (avoid marketing speak)
161
-
- See `.github/learn-folder-template/README.md` for detailed writing guidelines
162
-
163
-
**Checklist:**
164
-
165
-
Use `.github/learn-folder-template/CHECKLIST.md` to verify your learn/ folder is complete before submitting.
166
-
167
-
### 5. Package Managers if using Python and or Node (Doesn't matter what you use for any other framework/libary/language though)
97
+
### 4. Package Managers if using Python and or Node (Doesn't matter what you use for any other framework/libary/language though)
168
98
169
99
**Python:** Use [uv](https://github.com/astral-sh/uv) for dependency management. It's faster, better, and if you think pip or poetry is superior in 2026, you're simply not ready to contribute here. (I'm only slightly joking..... but use uv pls...)
0 commit comments