Skip to content

Commit 1cd847b

Browse files
Revise educational documentation requirements
Removed the requirement for a 'learn/' directory in projects and updated related documentation.
1 parent bb2ae3b commit 1cd847b

File tree

1 file changed

+1
-72
lines changed

1 file changed

+1
-72
lines changed

.github/CONTRIBUTING.md

Lines changed: 1 addition & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -71,17 +71,10 @@ PROJECTS/
7171
├── beginner/
7272
│ └── simple-port-scanner/
7373
│ ├── README.md
74-
│ ├── learn/
75-
│ │ ├── 00-OVERVIEW.md
76-
│ │ ├── 01-CONCEPTS.md
77-
│ │ ├── 02-ARCHITECTURE.md
78-
│ │ ├── 03-IMPLEMENTATION.md
79-
│ │ └── 04-CHALLENGES.md
8074
│ └── src/
8175
├── intermediate/
8276
│ └── oauth-token-analyzer/
8377
│ ├── README.md
84-
│ ├── learn/
8578
│ ├── .env.example
8679
│ ├── requirements.txt
8780
│ ├── src/
@@ -92,7 +85,6 @@ PROJECTS/
9285
└── advanced/
9386
└── bug-bounty-platform/
9487
├── README.md
95-
├── learn/
9688
├── .env.example
9789
├── docker-compose.yml
9890
├── backend/
@@ -101,70 +93,8 @@ PROJECTS/
10193
└── examples/
10294
```
10395

104-
### 4. Educational Documentation (learn/ Folder)
10596

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:
111-
112-
```bash
113-
cp -r .github/learn-folder-template PROJECTS/[difficulty]/[project-name]/learn
114-
cd PROJECTS/[difficulty]/[project-name]/learn
115-
rm README.md # Remove the template instructions
116-
```
117-
118-
Then fill in these five files:
119-
120-
1. **00-OVERVIEW.md** - Project introduction
121-
- What the project does and why it matters
122-
- Real world scenarios where it applies
123-
- 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)
16898

16999
**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...)
170100
```bash
@@ -281,7 +211,6 @@ git push origin add-your-project-name
281211
- [ ] Code follows existing style and conventions
282212
- [ ] Project has been tested
283213
- [ ] README documentation is complete
284-
- [ ] learn/ folder is complete with all 5 required files
285214
- [ ] Educational documentation follows quality standards
286215
- [ ] No security vulnerabilities introduced
287216
- [ ] Read and followed CONTRIBUTING.md guidelines

0 commit comments

Comments
 (0)