diff --git a/docs/DEVELOPER_GETTING_STARTED.md b/docs/DEVELOPER_GETTING_STARTED.md new file mode 100644 index 000000000..9c59e30b0 --- /dev/null +++ b/docs/DEVELOPER_GETTING_STARTED.md @@ -0,0 +1,29 @@ +# Getting Started (For Developers) + +This guide collects all the essential information new contributors need in one place. + +## 1. Required Reading +- Main **README.md** +- **CONTRIBUTING.md** +- How to write a ripper (wiki guide) +- Ripper requests list (good ideas for first PR) + +## 2. Setup Instructions +1. Fork the repository +2. Clone your fork +3. Create a new branch +4. Build with `mvn package` +5. Make your changes and test them +6. Push and open a Pull Request + +## 3. Recommended First Tasks +Visit the “up-for-grabs” issues for easy starter tasks: +https://github.com/4pr0n/ripme/labels/up-for-grabs + +## 4. Folder Structure +- `src/main/java` — Main code +- `rippers` — Ripper implementations +- `src/test/java` — Test cases + +## 5. Creating a Ripper +If you want to support a new site, follow the official wiki guide on creating rippers.