Skip to content

Commit d7c6dc6

Browse files
committed
add contributing guidelines
1 parent 890af59 commit d7c6dc6

File tree

2 files changed

+22
-4
lines changed

2 files changed

+22
-4
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Contributing Guidelines
2+
3+
Thank you for your interest in contributing to this repository. While this is primarily a personal collection of CTF blockchain challenges and writeups, contributions are welcome! However, please note that I might modify files added by you as I see fit.
4+
5+
## Contributions
6+
- **New Challenges**: Adding new CTF challenges from various competitions
7+
- **Solvers**: Adding new solutions or more efficient/interesting approaches to existing challenges
8+
- **Writeups**: Adding detailed explanations, solution walkthroughs, or improving existing documentation
9+
- **README Organization**: Improving categorization, descriptions, and fixing links
10+
11+
## Repository Structure
12+
- Challenges are primarily organized by CTF in the [src/](src/) directory
13+
- Each CTF has its own subdirectory (e.g., [src/ParadigmCTF2022/](src/ParadigmCTF2022/), [src/Ethernaut/](src/Ethernaut/))
14+
- This repo use CI to check if challenges are solved through test files
15+
- When solving CTFs, I use scripts, and contracts that are commonly used by both tests and scripts are extracted (e.g., `Exploit.sol`)
16+
- Please refer to the [src/Templates/](src/Templates/) directory for examples of the expected structure
17+
18+
---
19+
20+
If you have questions about contributing, feel free to contact [@vinami](https://x.com/vinami) (due to many spam messages, my replies may be slow).

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,8 @@
33
This repository collects blockchain challenges in CTFs and wargames.
44

55
These challenges are categorized by topic, not by difficulty or recommendation.
6-
Also, there are my writeups and exploits for some challenges (e.g., [Paradigm CTF 2022](src/ParadigmCTF2022/)).
7-
Please be aware that these contain spoilers.
8-
9-
If there are any incorrect descriptions, I would appreciate it if you could let me know via issue or PR!
6+
Some of them include writeups and solutions (e.g., [Paradigm CTF 2022](src/ParadigmCTF2022/)).
7+
Please be aware that these contain spoilers. For contribution guidelines, please see [CONTRIBUTING.md](CONTRIBUTING.md).
108

119
---
1210

0 commit comments

Comments
 (0)