Cole-Greer commented on code in PR #3380: URL: https://github.com/apache/tinkerpop/pull/3380#discussion_r3054531764
########## .skills/tinkerpop-dev/references/dev-environment-setup.md: ########## @@ -0,0 +1,140 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> + +# Development Environment Setup + +This guide walks through setting up a TinkerPop development environment from a fresh clone. +The canonical reference is `docs/src/dev/developer/development-environment.asciidoc`. + +## Prerequisites + +### Minimum (Java-only build) + +- **Java 11 or 17** — OpenJDK recommended. Use [SDKMAN!](https://sdkman.io/) to manage versions. + Note: some deep reflection requires `--add-opens` JVM options, which are already configured + in the pom files. +- **Maven 3.5.3+** — also manageable via SDKMAN. + +With just Java and Maven you can build JVM modules and get a clean `mvn clean install`, but +GLV builds and many integration tests will be skipped. + +### Full environment (all GLVs and integration tests) + +- **Docker and Docker Compose** — required for all GLV test execution. Docker Desktop includes + both. GLV tests run inside Docker containers, so local language runtimes are optional for + test execution via Maven. +- **Python 3.9+** — optional for local development; Docker handles test execution. +- **Node.js 20+ / npm 10+** — optional; Maven downloads a local copy via `frontend-maven-plugin`. + Consider [nvm](https://github.com/nvm-sh/nvm) for version management. +- **.NET SDK 8.0+** — optional; Docker handles test execution. +- **Go 1.22+** — optional; Docker handles test execution. Review Comment: ```suggestion - **Python 3.10+** — optional for local development; Docker handles test execution. - **Node.js 22+ / npm 10+** — optional; Maven downloads a local copy via `frontend-maven-plugin`. Consider [nvm](https://github.com/nvm-sh/nvm) for version management. - **.NET SDK 8.0+** — optional; Docker handles test execution. - **Go 1.25+** — optional; Docker handles test execution. ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
