Add Developer Getting Started Guide (#19)#2165
Add Developer Getting Started Guide (#19)#2165polasisubash wants to merge 1 commit intoRipMeApp:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a consolidated developer onboarding guide (docs/DEVELOPER_GETTING_STARTED.md) intended to centralize key contributor resources and first-time setup guidance for the RipMe codebase.
Changes:
- Introduces a new “Getting Started (For Developers)” document.
- Provides sections for required reading, local setup steps, starter issues, folder structure, and ripper creation guidance.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 4. Build with `mvn package` | ||
| 5. Make your changes and test them |
There was a problem hiding this comment.
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.
| 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` |
| - `src/main/java` — Main code | ||
| - `rippers` — Ripper implementations |
There was a problem hiding this comment.
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.
| - `src/main/java` — Main code | |
| - `rippers` — Ripper implementations | |
| - `src/main/java` — Main application code | |
| - `src/main/java/com/rarchives/ripme/ripper/rippers` — Ripper implementations |
| ## 1. Required Reading | ||
| - Main **README.md** | ||
| - **CONTRIBUTING.md** | ||
| - How to write a ripper (wiki guide) | ||
| - Ripper requests list (good ideas for first PR) | ||
|
|
There was a problem hiding this comment.
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.
| Visit the “up-for-grabs” issues for easy starter tasks: | ||
| https://github.com/4pr0n/ripme/labels/up-for-grabs |
There was a problem hiding this comment.
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.
| 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. |
There was a problem hiding this comment.
Actually, change this to the ripmeapp/ripme repo instead, because we shouldn't refer to 4pr0n/ripme anymore except as a legacy bug database.
|
@polasisubash please add links to the relevant wiki pages where appropriate. Please note that old references to the 4pr0n version of ripme should be updated to the modern setup for this repo (ripmeapp/ripme which forked from 4pr0n/ripme a long time ago) |
This pull request adds a new developer onboarding document as requested in Issue #19.
The new file docs/DEVELOPER_GETTING_STARTED.md provides a consolidated "Getting Started (for Developers)" guide. It groups all essential information that new contributors need, including:
Links to important project documents (README.md, CONTRIBUTING.md, ripper creation guide).
Instructions for setting up the project locally.
Steps for building and testing with Maven.
A list of beginner-friendly issues to help contributors make their first PR.
A quick overview of the project’s folder structure.
Guidance on how to create a new ripper.
This improves developer onboarding by placing all relevant resources in a single, easy-to-find document.
No functional code changes are included; this PR updates documentation only.