Add comprehensive Copilot instructions for Neo4j Spatial development #450
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a comprehensive
.github/copilot-instructions.mdfile to help coding agents work efficiently with the Neo4j Spatial codebase without extensive exploration.What's Added
The instructions provide essential information about:
Repository Overview:
Build System Documentation:
./mvnw) with essential commands-Denv=short|default|dev|long)Project Architecture:
SpatialDatabaseService,Layer, and RTree indexDevelopment Workflow:
Why This Helps
These instructions will significantly reduce the time coding agents spend exploring the codebase and minimize build failures by:
The instructions are designed to be comprehensive yet concise (under 2 pages) and focus on practical information that agents need to successfully contribute to the project.
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
raw.github.com/usr/lib/jvm/temurin-17-jdk-amd64/bin/java -classpath /home/REDACTED/work/spatial/spatial/.mvn/wrapper/maven-wrapper.jar -Dmaven.multiModuleProjectDirectory=/home/REDACTED/work/spatial/spatial org.apache.maven.wrapper.MavenWrapperMain clean compile -q(dns block)/usr/lib/jvm/temurin-17-jdk-amd64/bin/java --enable-native-access=ALL-UNNAMED -classpath /usr/share/apache-maven-3.9.11/boot/plexus-classworlds-2.9.0.jar -Dclassworlds.conf=/usr/share/apache-maven-3.9.11/bin/m2.conf -Dmaven.home=/usr/share/apache-maven-3.9.11 -Dlibrary.jansi.path=/usr/share/apache-maven-3.9.11/lib/jansi-native -Dmaven.multiModuleProjectDirectory=/home/REDACTED/work/spatial/spatial org.codehaus.plexus.classworlds.launcher.Launcher dependency:resolve -q(dns block)/usr/lib/jvm/temurin-17-jdk-amd64/bin/java -classpath /home/REDACTED/work/spatial/spatial/.mvn/wrapper/maven-wrapper.jar -Dmaven.multiModuleProjectDirectory=/home/REDACTED/work/spatial/spatial org.apache.maven.wrapper.MavenWrapperMain -q dependency:tree(dns block)repo.osgeo.org/usr/lib/jvm/temurin-17-jdk-amd64/bin/java -classpath /home/REDACTED/work/spatial/spatial/.mvn/wrapper/maven-wrapper.jar -Dmaven.multiModuleProjectDirectory=/home/REDACTED/work/spatial/spatial org.apache.maven.wrapper.MavenWrapperMain clean compile -q(dns block)curl -I REDACTED(dns block)/usr/lib/jvm/temurin-17-jdk-amd64/bin/java --enable-native-access=ALL-UNNAMED -classpath /usr/share/apache-maven-3.9.11/boot/plexus-classworlds-2.9.0.jar -Dclassworlds.conf=/usr/share/apache-maven-3.9.11/bin/m2.conf -Dmaven.home=/usr/share/apache-maven-3.9.11 -Dlibrary.jansi.path=/usr/share/apache-maven-3.9.11/lib/jansi-native -Dmaven.multiModuleProjectDirectory=/home/REDACTED/work/spatial/spatial org.codehaus.plexus.classworlds.launcher.Launcher dependency:resolve -q(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.