feat: Add .github/copilot-instructions.md for coding agent onboarding#362
feat: Add .github/copilot-instructions.md for coding agent onboarding#362
Conversation
Co-authored-by: edeandrea <363447+edeandrea@users.noreply.github.com>
|
@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:
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: |
|
@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>
Done in commit |
There was a problem hiding this comment.
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.
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>
The early commits (
Already added in commit |
.github/copilot-instructions.mdfor coding agent onboardingmodule-info.javaclaim to note that only library modules have oneDOCLING_IMAGEconstant 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.