✨ Set up Copilot instructions

[Copilot]

Description

Adds .github/copilot-instructions.md to provide GitHub Copilot with repository-specific context for better code suggestions.

Resolves #319

Content Coverage

• Architecture: Monorepo structure (xapi-model, xapi-client, xapi-model-spring-boot-starter, samples)
• Stack: Java 17, Maven, Spring Boot 3.5.7, Lombok, Jackson with custom xAPI modules
• Patterns: Immutable objects, fluent builders, Jakarta Bean Validation
• Testing: JUnit 5, Hamcrest matchers, 300+ xAPI spec conformance tests
• Quality: Google Java Style Guide via CheckStyle, SonarCloud, CodeQL
• xAPI Compliance: Strict validation rules, specification constraints

Key Examples

Immutable fluent pattern used throughout:

Statement statement = Statement.builder()
    .agentActor(a -> a.name("User").mbox("mailto:user@example.com"))
    .verb(Verb.ATTEMPTED)
    .activityObject(o -> o.id("https://example.com/activity/1"))
    .build();

// Modification via toBuilder()
Statement completed = statement.toBuilder().verb(Verb.COMPLETED).build();

Checklist:

• Public methods are documented
• Public methods are tested
• New and existing tests pass when run locally
• There are no new warnings or errors

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:

• gh.io
  • Triggering command: curl -L REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Original prompt

---

This section details on the original issue you should resolve

<issue_title>✨ Set up Copilot instructions</issue_title>
<issue_description>Configure instructions for this repository as documented in Best practices for Copilot coding agent in your repository.

</issue_description>

Comments on the Issue (you are @copilot in this section)

• Fixes ✨ Set up Copilot instructions #319

---

💡 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.

[thomasturrell]

@copilot try again, i have disabled the firewall for gh.io

[Copilot]

@copilot try again, i have disabled the firewall for gh.io

I'm still unable to access gh.io or docs.github.com - the requests are being blocked by a DNS monitoring proxy. However, the current .github/copilot-instructions.md file (commit 6fffae8) follows GitHub's recommended structure for Copilot instructions:

• Located in the standard .github/ directory
• Comprehensive project context (tech stack, architecture, patterns)
• Build/test commands and workflows
• Code style guidelines and examples
• Module-specific guidance

The file covers the key areas needed for Copilot to provide context-aware suggestions for this xAPI Java repository. If you have access to the documentation and notice any specific missing elements, please let me know and I'll update the file accordingly.

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:

• gh.io
  • Triggering command: curl -L -A Mozilla/5.0 REDACTED (dns block)
• https://api.github.com/search/code
  • Triggering command: curl -s REDACTED (http block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[sonarqubecloud]

Please retry analysis of this Pull-Request directly on SonarQube Cloud