Add comprehensive GitHub Copilot instructions for kerb4j development#70
Draft
Add comprehensive GitHub Copilot instructions for kerb4j development#70
Conversation
Co-authored-by: bedrin <4654384+bedrin@users.noreply.github.com>
Co-authored-by: bedrin <4654384+bedrin@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] ✨ Set up Copilot instructions
Add comprehensive GitHub Copilot instructions for kerb4j development
Aug 30, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 guide GitHub Copilot coding agents in working effectively with the kerb4j codebase.What's included
The instructions provide exhaustive guidance for developers working with this Kerberos/SPNEGO authentication library:
Validated Build Commands
All commands have been tested and timing measured:
mvn clean compile -q(9 seconds) - compilation onlymvn clean package -q(48 seconds) - full build with testsmvn test -q(24 seconds) - tests onlymvn clean install -DskipTests -q(28 seconds) - install without testsCritical Timing and Safety Guidelines
Project Structure Documentation
Complete overview of all 11 modules:
kerb4j-base64/- Base64 encoding utilitieskerb4j-common/- Core Kerberos functionality and test infrastructurekerb4j-client/- Client-side SPNEGO/Kerberos authenticationkerb4j-server/- Server-side authentication (Spring Security, Tomcat, LDAP)Validation Scenarios
Specific guidance for testing changes:
Key Classes and Development Patterns
Documentation of important classes like
SpnegoClient,SpnegoContext,KerberosSecurityTestcase, and proper usage patterns for thread-safe ticket caching.Validation Process
Every command and instruction was thoroughly validated:
The instructions follow the imperative tone requirement and prioritize working, validated commands over theoretical guidance.
Fixes #69.
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:
server.springsource.org/usr/lib/jvm/temurin-17-jdk-amd64/bin/java -jar /home/REDACTED/work/kerb4j/kerb4j/kerb4j-server/kerb4j-server-spring-security/target/surefire/surefirebooter-20250830080023845_24.jar /home/REDACTED/work/kerb4j/kerb4j/kerb4j-server/kerb4j-server-spring-security/target/surefire 2025-08-30T07-59-46_323-jvmRun1 surefire-20250830080023845_22tmp surefire_4-20250830080023845_23tmp(dns block)/usr/lib/jvm/temurin-17-jdk-amd64/bin/java -jar /home/REDACTED/work/kerb4j/kerb4j/kerb4j-server/kerb4j-server-spring-security/target/surefire/surefirebooter-20250830080059520_24.jar /home/REDACTED/work/kerb4j/kerb4j/kerb4j-server/kerb4j-server-spring-security/target/surefire 2025-08-30T08-00-46_614-jvmRun1 surefire-20250830080059520_22tmp surefire_4-20250830080059520_23tmp(dns block)/usr/lib/jvm/temurin-17-jdk-amd64/bin/java -jar /home/REDACTED/work/kerb4j/kerb4j/kerb4j-server/kerb4j-server-spring-security/target/surefire/surefirebooter-20250830080525756_24.jar /home/REDACTED/work/kerb4j/kerb4j/kerb4j-server/kerb4j-server-spring-security/target/surefire 2025-08-30T08-04-53_814-jvmRun1 surefire-20250830080525756_22tmp surefire_4-20250830080525756_23tmp(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.