Skip to content

feat: Add .github/copilot-instructions.md for coding agent onboarding#362

Merged
edeandrea merged 6 commits intomainfrom
copilot/add-copilot-instructions
Feb 24, 2026
Merged

feat: Add .github/copilot-instructions.md for coding agent onboarding#362
edeandrea merged 6 commits intomainfrom
copilot/add-copilot-instructions

Conversation

Copy link
Contributor

Copilot AI commented Feb 24, 2026

  • Add .github/copilot-instructions.md for coding agent onboarding
  • Expand "Code Style" section with full Conventional Commits format, type table, and examples
  • Fix WireMock/Docker note to accurately describe which modules require Docker
  • Fix JPMS module-info.java claim to note that only library modules have one
  • Improve DOCLING_IMAGE constant description to clarify it uses a concrete version tag

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

Co-authored-by: edeandrea <363447+edeandrea@users.noreply.github.com>
Copilot AI changed the title [WIP] Add onboarding instructions for Copilot coding agent Add .github/copilot-instructions.md for coding agent onboarding Feb 24, 2026
@edeandrea
Copy link
Contributor

@copilot can you ensure that all commits follow the semantic conventions specification?

Copy link
Contributor Author

Copilot AI commented Feb 24, 2026

@copilot can you ensure that all commits follow the semantic conventions specification?

The existing commit messages ("Initial plan" and "Add .github/copilot-instructions.md for coding agent onboarding") don't follow the Conventional Commits spec. Unfortunately, since those commits are already pushed, I'm unable to rewrite that history (force push is not available in this environment).

The commits should have been:

  • chore: initial plan (or omitted entirely)
  • docs: add .github/copilot-instructions.md for coding agent onboarding

All future commits I make will use the conventional format. When merging this PR, the commits can be squashed with a proper message such as:

docs: add .github/copilot-instructions.md for coding agent onboarding

@edeandrea
Copy link
Contributor

@copilot Can you add the note about semantic conventions to the instructions that you've created for coding agent onboarding for future reference?

Co-authored-by: edeandrea <363447+edeandrea@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Feb 24, 2026

@copilot Can you add the note about semantic conventions to the instructions that you've created for coding agent onboarding for future reference?

Done in commit 1fa3b07. The "Code Style" section now includes a full Conventional Commits reference: the <type>[scope]: <description> format, a table of common types used in this project, concrete examples, and an explicit note that coding agents must follow this convention.

@edeandrea edeandrea marked this pull request as ready for review February 24, 2026 18:44
Copilot AI review requested due to automatic review settings February 24, 2026 18:44
@edeandrea edeandrea changed the title Add .github/copilot-instructions.md for coding agent onboarding feat: Add .github/copilot-instructions.md for coding agent onboarding Feb 24, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a dedicated .github/copilot-instructions.md onboarding document to guide coding agents (and contributors) on repo structure, build/test workflows, and key engineering conventions for docling-java.

Changes:

  • Introduces a comprehensive Copilot instructions document covering modules, build commands, and key APIs.
  • Expands “Code Style” guidance with a detailed Conventional Commits format, types table, and examples.
  • Documents testing tools used in the repo (JUnit 5, AssertJ, WireMock, Testcontainers) and CI workflow expectations.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

edeandrea and others added 2 commits February 24, 2026 13:50
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Eric Deandrea <eric@ericdeandrea.dev>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Eric Deandrea <eric@ericdeandrea.dev>
Co-authored-by: edeandrea <363447+edeandrea@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Feb 24, 2026

@copilot can you ensure that all commits follow the semantic conventions specification?

The early commits (a98a978 "Initial plan" and 391551d "Add .github/copilot-instructions.md...") predate the Conventional Commits guidance and cannot be rewritten since force-push is not available. All subsequent commits (1fa3b07, 8ebf886, 489703e, c2e09d6) follow the convention. When merging this PR, please squash with a message such as docs: add .github/copilot-instructions.md for coding agent onboarding.

@copilot Can you add the note about semantic conventions to the instructions that you've created for coding agent onboarding for future reference?

Already added in commit 1fa3b07. The "Code Style" section includes the full <type>[scope]: <description> format, a type table, concrete examples, and an explicit note that every commit — including those from coding agents — must follow this convention.

@edeandrea edeandrea merged commit 7a25e4e into main Feb 24, 2026
2 of 4 checks passed
@edeandrea edeandrea deleted the copilot/add-copilot-instructions branch February 24, 2026 18:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants