Skip to content

Add GitHub Copilot instructions for bnd repository#4

Open
Copilot wants to merge 2 commits intomasterfrom
copilot/fix-c2059c10-a7dc-42ba-b3b0-1e80c44468b0
Open

Add GitHub Copilot instructions for bnd repository#4
Copilot wants to merge 2 commits intomasterfrom
copilot/fix-c2059c10-a7dc-42ba-b3b0-1e80c44468b0

Conversation

Copy link

Copilot AI commented Oct 6, 2025

This PR adds comprehensive GitHub Copilot instructions to help AI-assisted development in the bnd/bndtools repository, following the best practices documented at https://gh.io/copilot-coding-agent-tips.

What's Added

Created .github/copilot-instructions.md with repository-specific guidance covering:

Build & Development Environment

  • Build system requirements (Java 17, Gradle/Maven wrappers)
  • Complete build commands for workspace projects, Gradle plugins, and Maven plugins
  • Testing commands including running specific test classes and methods

Code Organization & Standards

  • Project structure overview (bndlib, plugins, Eclipse components)
  • Module naming conventions (biz.aQute.* and bndtools.* patterns)
  • Testing best practices using soft assertions and temporary directory annotations
  • Java coding conventions and commit message format

OSGi & API Compatibility

  • Backward compatibility guidelines
  • Semantic versioning requirements
  • Baselining tool usage

Eclipse Plugin Development

  • Instructions for launching Bndtools from Eclipse
  • Guidelines for adding error/warning markers
  • ExtensionFacade usage patterns

Contribution Workflow

  • Git triangular workflow setup
  • Pull request guidelines
  • Testing requirements

Quick Reference

  • Common development commands
  • Key documentation files
  • Resource links

Why This Helps

This file provides context-aware guidance for GitHub Copilot and other AI coding assistants, enabling them to:

  • Generate code that follows bnd's specific patterns and conventions
  • Suggest appropriate build and test commands
  • Understand the repository structure and module organization
  • Apply correct testing patterns (soft assertions, temporary directories)
  • Maintain backward compatibility and API standards
  • Follow the contribution workflow properly

The instructions are tailored specifically to the bnd project's unique characteristics as an OSGi development toolkit with multiple build systems, Eclipse integration, and strict compatibility requirements.

Resolves the issue to configure instructions for this repository as documented in the best practices guide.

Original prompt

Configure instructions for this repository as documented in Best practices for Copilot coding agent in your repository.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Co-authored-by: laeubi <1331477+laeubi@users.noreply.github.com>
Copilot AI changed the title [WIP] Configure instructions for this repository as documented in [Best practices for Copilot coding agent in your repository](https://gh.io/copilot-coding-agent-tips). <Onboard this repo> Add GitHub Copilot instructions for bnd repository Oct 6, 2025
Copilot AI requested a review from laeubi October 6, 2025 08:17
@laeubi laeubi marked this pull request as ready for review October 6, 2025 08:18
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.

2 participants