Skip to content

Add Developer Getting Started Guide (#19) #2165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
polasisubash wants to merge 1 commit into
base: main
Choose a base branch
from
+29 −0
Open

Add Developer Getting Started Guide (#19) #2165

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions docs/DEVELOPER_GETTING_STARTED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)

Comment on lines +5 to +10
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR description says this doc provides links to key resources, but this “Required Reading” list is plain text (no actual links). Consider converting these bullets to clickable relative links to README.md/CONTRIBUTING.md and adding the explicit wiki + ripper-request links referenced in Issue #19.

Copilot uses AI. Check for mistakes.
## 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
Comment on lines +15 to +16
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The build command here uses Maven (mvn package), but this repository’s documented build/test workflow uses Gradle via gradlew (see README “Compiling & Building”). Update the setup steps to use the supported ./gradlew ... commands (and consider including a test command like test/testAll) so new contributors can actually build the project.

Suggested change
4. Build with `mvn package`
5. Make your changes and test them
4. Build with `./gradlew build`
5. Make your changes and run tests with `./gradlew test`

Copilot uses AI. Check for mistakes.
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
Comment on lines +20 to +21
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor: the “up-for-grabs” URL is a bare link and uses curly quotes in the preceding sentence. Consider formatting it as a standard Markdown link and using straight quotes to avoid copy/paste/search issues in some terminals/editors.

Suggested change
Visit the “up-for-grabs” issues for easy starter tasks:
https://github.com/4pr0n/ripme/labels/up-for-grabs
Visit the ["up-for-grabs" issues](https://github.com/4pr0n/ripme/labels/up-for-grabs) for easy starter tasks.

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Contributor

@metaprime metaprime Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, change this to the ripmeapp/ripme repo instead, because we shouldn't refer to 4pr0n/ripme anymore except as a legacy bug database.


## 4. Folder Structure
- `src/main/java` — Main code
- `rippers` — Ripper implementations
Comment on lines +24 to +25
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section says rippers live in a top-level rippers directory, but there is no such folder in the repo. Ripper implementations are under src/main/java/com/rarchives/ripme/ripper/rippers/; please update the folder structure bullets to reflect the actual paths.

Suggested change
- `src/main/java` — Main code
- `rippers` — Ripper implementations
- `src/main/java` — Main application code
- `src/main/java/com/rarchives/ripme/ripper/rippers` — Ripper implementations

Copilot uses AI. Check for mistakes.
- `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.